An open source design system that's fully customizable and agent ready
TypeScript
fix(docsite): restore Icon and Skeleton properties-tab previews (#3175)
Durvesh Pilankar9846a62cae6b
diff --git a/.changeset/docsite-icon-skeleton-properties-preview.md b/.changeset/docsite-icon-skeleton-properties-preview.mdnew file mode 100644index 0000000000..511f6b28e9--- /dev/null+++ b/.changeset/docsite-icon-skeleton-properties-preview.md@@ -0,0 +1,6 @@+---+'@astryxdesign/core': patch+---++[docs] Restore the Icon and Skeleton properties-tab previews on the docsite. Icon now seeds a default `icon` (it was a required, non-generatable prop), and Skeleton renders with concrete preview dimensions instead of collapsing at `100%` (#2848, #2875)+@durvesh1992diff --git a/apps/docsite/src/__tests__/component-preview-state.test.ts b/apps/docsite/src/__tests__/component-preview-state.test.tsindex 04a4784b31..e970edd0c4 100644--- a/apps/docsite/src/__tests__/component-preview-state.test.ts+++ b/apps/docsite/src/__tests__/component-preview-state.test.ts@@ -94,6 +94,43 @@ describe('component detail preview state', () => {expect(getMissingRequiredProps(knobs, state)).toEqual(['config']);});+ it("satisfies Icon's required, non-generatable icon prop via playground defaults", () => {+ const knobs = pickPrimaryProps('Icon', [+ prop({+ name: 'icon',+ type: 'IconName | ComponentType<SVGProps>',+ required: true,+ }),+ ]);++ // Without a playground default the required icon prop cannot be generated.+ expect(getMissingRequiredProps(knobs, buildInitialState(knobs))).toEqual([+ 'icon',+ ]);++ // The doc's playground default seeds a valid semantic name.+ const state = buildInitialState(knobs, {defaults: {icon: 'search'}});+ expect(state.icon).toBe('search');+ expect(getMissingRequiredProps(knobs, state)).toEqual([]);+ });++ it('gives Skeleton concrete preview dimensions via playground defaults', () => {+ const knobs = pickPrimaryProps('Skeleton', [+ prop({name: 'width', type: 'number | string', default: "'100%'"}),+ prop({name: 'height', type: 'number | string', default: "'100%'"}),+ ]);++ // Doc defaults alone would render at 100% (collapses in the centered preview).+ expect(buildInitialState(knobs).width).toBe('100%');++ // Playground defaults override with visible pixel dimensions.+ const state = buildInitialState(knobs, {+ defaults: {width: 200, height: 24},+ });+ expect(state.width).toBe(200);+ expect(state.height).toBe(24);+ });+it('wires controlled open previews back to their isOpen prop', () => {const onPropChange = vi.fn();const runtimeState = buildRuntimePreviewState(diff --git a/packages/core/src/Icon/Icon.doc.mjs b/packages/core/src/Icon/Icon.doc.mjsindex 9b004d1067..3fef54c24f 100644--- a/packages/core/src/Icon/Icon.doc.mjs+++ b/packages/core/src/Icon/Icon.doc.mjs@@ -7,6 +7,14 @@ export const docs = {displayName: 'Icon',category: 'Content',keywords: ["icon","svg","glyph","symbol","pictogram","graphic","vector"],+ playground: {+ // `icon` is required and its type can't be auto-generated, so the+ // properties-tab preview showed "Missing: icon". Seed a valid semantic+ // icon name so the interactive preview renders.+ defaults: {+ icon: 'search',+ },+ },props: [{name: 'icon',diff --git a/packages/core/src/Skeleton/Skeleton.doc.mjs b/packages/core/src/Skeleton/Skeleton.doc.mjsindex 79f09baf05..facbeb7e7c 100644--- a/packages/core/src/Skeleton/Skeleton.doc.mjs+++ b/packages/core/src/Skeleton/Skeleton.doc.mjs@@ -7,6 +7,15 @@ export const docs = {displayName: 'Skeleton',category: 'Feedback & Status',keywords: ["skeleton","placeholder","loading","shimmer","pulse","loader","bone","ghost","preloader"],+ playground: {+ // width/height default to '100%', which collapses to nothing inside the+ // centered properties-tab preview. Give the preview concrete dimensions+ // so the skeleton is actually visible.+ defaults: {+ width: 200,+ height: 24,+ },+ },props: [{name: 'width',