Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(docsite): open command palette preview inline (#2815)

Cindy Zhang2e4068e31423
diff --git a/apps/docsite/src/__tests__/component-preview-state.test.ts b/apps/docsite/src/__tests__/component-preview-state.test.ts
index 2b799e9f93..a1a64be35e 100644
--- a/apps/docsite/src/__tests__/component-preview-state.test.ts
+++ b/apps/docsite/src/__tests__/component-preview-state.test.ts
@@ -52,6 +52,37 @@ describe('component detail preview state', () => {
expect(getMissingRequiredProps(knobs, state)).toEqual([]);
});
+ it('keeps generated required fallbacks when playground defaults open an inline preview', () => {
+ const knobs = pickPrimaryProps('CommandPalette', [
+ prop({name: 'isOpen', type: 'boolean', required: true}),
+ prop({
+ name: 'onOpenChange',
+ type: '(isOpen: boolean) => void',
+ required: true,
+ }),
+ prop({name: 'searchSource', type: 'XDSSearchSource<T>', required: true}),
+ prop({name: 'isInline', type: 'boolean'}),
+ ]);
+
+ const state = buildInitialState(knobs, {
+ defaults: {
+ isOpen: true,
+ isInline: true,
+ onOpenChange: undefined,
+ },
+ });
+
+ expect(state.isOpen).toBe(true);
+ expect(state.isInline).toBe(true);
+ expect(state.onOpenChange).toEqual(expect.any(Function));
+ expect(state.searchSource).toMatchObject({
+ search: expect.any(Function),
+ bootstrap: expect.any(Function),
+ cancel: expect.any(Function),
+ });
+ expect(getMissingRequiredProps(knobs, state)).toEqual([]);
+ });
+
it('reports required props that cannot be generated safely', () => {
const knobs = pickPrimaryProps('CustomWidget', [
prop({name: 'config', type: 'CustomConfig', required: true}),
diff --git a/packages/core/src/CommandPalette/CommandPalette.doc.mjs b/packages/core/src/CommandPalette/CommandPalette.doc.mjs
index 2e2916c56d..738cda1c10 100644
--- a/packages/core/src/CommandPalette/CommandPalette.doc.mjs
+++ b/packages/core/src/CommandPalette/CommandPalette.doc.mjs
@@ -20,6 +20,13 @@ export const docs = {
'navigation',
],
description: 'Root component. Manages open state, search, keyboard navigation, and composition slots.',
+ playground: {
+ defaults: {
+ isOpen: true,
+ isInline: true,
+ onOpenChange: undefined,
+ },
+ },
props: [
{
name: 'isOpen',