Skip to content

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

TypeScript

refactor(Stepper): move to @xds/lab — API needs rework (#2335)

Cindy Zhange605545f2a49
diff --git a/apps/storybook/.storybook/main.ts b/apps/storybook/.storybook/main.ts
index 27c12d2e88..da5f9a8edf 100644
--- a/apps/storybook/.storybook/main.ts
+++ b/apps/storybook/.storybook/main.ts
@@ -68,6 +68,8 @@ const config: StorybookConfig = {
aliases: {
'@xds/core/*': [path.join(rootDir, 'packages/core/src/*')],
'@xds/core': [path.join(rootDir, 'packages/core/src')],
+ '@xds/lab/*': [path.join(rootDir, 'packages/lab/src/*')],
+ '@xds/lab': [path.join(rootDir, 'packages/lab/src')],
'@xds/theme-default/*': [
path.join(rootDir, 'packages/themes/default/src/*'),
],
@@ -94,6 +96,7 @@ const config: StorybookConfig = {
alias: {
...config.resolve?.alias,
'@xds/core': path.resolve(rootDir, 'packages/core/src'),
+ '@xds/lab': path.resolve(rootDir, 'packages/lab/src'),
'@xds/theme-default': path.resolve(
rootDir,
'packages/themes/default/src/source.ts',
diff --git a/apps/storybook/stories/CircularProgress.stories.tsx b/apps/storybook/stories/CircularProgress.stories.tsx
index 9ab53cff66..1f869d8dca 100644
--- a/apps/storybook/stories/CircularProgress.stories.tsx
+++ b/apps/storybook/stories/CircularProgress.stories.tsx
@@ -1,11 +1,11 @@
// Copyright (c) Meta Platforms, Inc. and affiliates.
import type {Meta, StoryObj} from '@storybook/react';
-import {XDSCircularProgress} from '@xds/core/CircularProgress';
+import {XDSCircularProgress} from '@xds/lab/CircularProgress';
import {XDSText} from '@xds/core/Text';
const meta: Meta<typeof XDSCircularProgress> = {
- title: 'Core/CircularProgress',
+ title: 'Lab/CircularProgress',
component: XDSCircularProgress,
tags: ['autodocs'],
argTypes: {
diff --git a/apps/storybook/stories/Stepper.stories.tsx b/apps/storybook/stories/Stepper.stories.tsx
index 03a2e5e03a..63e0174bac 100644
--- a/apps/storybook/stories/Stepper.stories.tsx
+++ b/apps/storybook/stories/Stepper.stories.tsx
@@ -2,13 +2,13 @@
import {useState} from 'react';
import type {Meta, StoryObj} from '@storybook/react';
-import {XDSStepper, XDSStep} from '@xds/core/Stepper';
+import {XDSStepper, XDSStep} from '@xds/lab/Stepper';
import {XDSTextInput} from '@xds/core/TextInput';
import {XDSButton} from '@xds/core/Button';
import {XDSText} from '@xds/core/Text';
const meta: Meta<typeof XDSStepper> = {
- title: 'Core/Navigation/Stepper',
+ title: 'Lab/Stepper',
component: XDSStepper,
tags: ['autodocs'],
argTypes: {
diff --git a/apps/storybook/tsconfig.json b/apps/storybook/tsconfig.json
index 690b9d5395..881681a9e4 100644
--- a/apps/storybook/tsconfig.json
+++ b/apps/storybook/tsconfig.json
@@ -13,6 +13,13 @@
"../../packages/theme/src/*/index.ts",
"../../packages/theme/src/*"
],
+ "@xds/lab": [
+ "../../packages/lab/src/index.ts"
+ ],
+ "@xds/lab/*": [
+ "../../packages/lab/src/*/index.ts",
+ "../../packages/lab/src/*"
+ ],
"@xds/build/vite": [
"../../packages/build/src/vite.ts"
]
diff --git a/packages/cli/templates/blocks/components/CircularProgress/CircularProgressShowcase.doc.mjs b/packages/cli/templates/blocks/components/CircularProgress/CircularProgressShowcase.doc.mjs
deleted file mode 100644
index e0abe0d208..0000000000
--- a/packages/cli/templates/blocks/components/CircularProgress/CircularProgressShowcase.doc.mjs
+++ /dev/null
@@ -1,14 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
-export const doc = {
- type: 'block',
- exampleFor: 'CircularProgress',
- name: 'CircularProgress',
- isReady: true,
- aspectRatio: 1,
- isShowcase: true,
- description:
- 'A circular progress ring filled to 75% with a center label.',
- componentsUsed: ['CircularProgress'],
-};
diff --git a/packages/cli/templates/blocks/components/CircularProgress/CircularProgressShowcase.tsx b/packages/cli/templates/blocks/components/CircularProgress/CircularProgressShowcase.tsx
deleted file mode 100644
index 73b23c0ca3..0000000000
--- a/packages/cli/templates/blocks/components/CircularProgress/CircularProgressShowcase.tsx
+++ /dev/null
@@ -1,13 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-'use client';
-
-import {XDSCircularProgress} from '@xds/core/CircularProgress';
-
-export default function CircularProgressShowcase() {
- return (
- <XDSCircularProgress value={75} label="Progress" size="lg">
- 75%
- </XDSCircularProgress>
- );
-}
diff --git a/packages/cli/templates/blocks/components/Stepper/StepperShowcase.doc.mjs b/packages/cli/templates/blocks/components/Stepper/StepperShowcase.doc.mjs
deleted file mode 100644
index a1629be469..0000000000
--- a/packages/cli/templates/blocks/components/Stepper/StepperShowcase.doc.mjs
+++ /dev/null
@@ -1,13 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
-export const doc = {
- type: 'block',
- exampleFor: 'Stepper',
- name: 'Stepper',
- isReady: true,
- aspectRatio: 16 / 9,
- isShowcase: true,
- description: 'A horizontal stepper with three steps, the second step active.',
- componentsUsed: ['Stepper'],
-};
diff --git a/packages/cli/templates/blocks/components/Stepper/StepperShowcase.tsx b/packages/cli/templates/blocks/components/Stepper/StepperShowcase.tsx
deleted file mode 100644
index 20dd854983..0000000000
--- a/packages/cli/templates/blocks/components/Stepper/StepperShowcase.tsx
+++ /dev/null
@@ -1,15 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-'use client';
-
-import {XDSStepper, XDSStep} from '@xds/core/Stepper';
-
-export default function StepperShowcase() {
- return (
- <XDSStepper activeStep={1}>
- <XDSStep step={0} label="Account" />
- <XDSStep step={1} label="Profile" />
- <XDSStep step={2} label="Review" />
- </XDSStepper>
- );
-}
diff --git a/packages/core/package.json b/packages/core/package.json
index d0959d9e04..9cc7ec18e4 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -175,12 +175,6 @@
"import": "./dist/CheckboxList/index.mjs",
"require": "./dist/CheckboxList/index.js"
},
- "./CircularProgress": {
- "source": "./src/CircularProgress/index.ts",
- "types": "./dist/CircularProgress/index.d.ts",
- "import": "./dist/CircularProgress/index.mjs",
- "require": "./dist/CircularProgress/index.js"
- },
"./Citation": {
"source": "./src/Citation/index.ts",
"types": "./dist/Citation/index.d.ts",
@@ -505,12 +499,6 @@
"import": "./dist/StatusDot/index.mjs",
"require": "./dist/StatusDot/index.js"
},
- "./Stepper": {
- "source": "./src/Stepper/index.ts",
- "types": "./dist/Stepper/index.d.ts",
- "import": "./dist/Stepper/index.mjs",
- "require": "./dist/Stepper/index.js"
- },
"./Switch": {
"source": "./src/Switch/index.ts",
"types": "./dist/Switch/index.d.ts",
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index 59dd0ea3b5..f8b7fb5972 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -38,7 +38,6 @@ export * from './Markdown';
export * from './Citation';
export * from './CheckboxInput';
export * from './CheckboxList';
-export * from './CircularProgress';
export * from './Collapsible';
export * from './RadioList';
export * from './Resizable';
@@ -97,7 +96,6 @@ export * from './SideNav';
export * from './MobileNav';
export * from './Pagination';
export * from './ProgressBar';
-export * from './Stepper';
// Layout utilities and components (includes XDSHStack, XDSVStack)
export * from './Layout';
diff --git a/packages/core/src/CircularProgress/CircularProgress.doc.mjs b/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
similarity index 100%
rename from packages/core/src/CircularProgress/CircularProgress.doc.mjs
rename to packages/lab/src/CircularProgress/CircularProgress.doc.mjs
diff --git a/packages/core/src/CircularProgress/XDSCircularProgress.test.tsx b/packages/lab/src/CircularProgress/XDSCircularProgress.test.tsx
similarity index 100%
rename from packages/core/src/CircularProgress/XDSCircularProgress.test.tsx
rename to packages/lab/src/CircularProgress/XDSCircularProgress.test.tsx
diff --git a/packages/core/src/CircularProgress/XDSCircularProgress.tsx b/packages/lab/src/CircularProgress/XDSCircularProgress.tsx
similarity index 98%
rename from packages/core/src/CircularProgress/XDSCircularProgress.tsx
rename to packages/lab/src/CircularProgress/XDSCircularProgress.tsx
index 95371ff8f9..507842d3a6 100644
--- a/packages/core/src/CircularProgress/XDSCircularProgress.tsx
+++ b/packages/lab/src/CircularProgress/XDSCircularProgress.tsx
@@ -26,9 +26,9 @@ import {
fontWeightVars,
spacingVars,
typeScaleVars,
-} from '../theme/tokens.stylex';
-import {xdsClassName, mergeProps} from '../utils';
-import type {XDSBaseProps} from '../XDSBaseProps';
+} from '@xds/core/theme/tokens.stylex';
+import {xdsClassName, mergeProps} from '@xds/core/utils';
+import type {XDSBaseProps} from '@xds/core';
/**
* Extensible variant map for XDSCircularProgress.
diff --git a/packages/core/src/CircularProgress/index.ts b/packages/lab/src/CircularProgress/index.ts
similarity index 100%
rename from packages/core/src/CircularProgress/index.ts
rename to packages/lab/src/CircularProgress/index.ts
diff --git a/packages/core/src/Stepper/Stepper.doc.mjs b/packages/lab/src/Stepper/Stepper.doc.mjs
similarity index 100%
rename from packages/core/src/Stepper/Stepper.doc.mjs
rename to packages/lab/src/Stepper/Stepper.doc.mjs
diff --git a/packages/core/src/Stepper/XDSStep.tsx b/packages/lab/src/Stepper/XDSStep.tsx
similarity index 98%
rename from packages/core/src/Stepper/XDSStep.tsx
rename to packages/lab/src/Stepper/XDSStep.tsx
index 7d1c2a66e6..902dd8c43c 100644
--- a/packages/core/src/Stepper/XDSStep.tsx
+++ b/packages/lab/src/Stepper/XDSStep.tsx
@@ -27,10 +27,10 @@ import {
typeScaleVars,
durationVars,
easeVars,
-} from '../theme/tokens.stylex';
-import {xdsClassName, mergeProps} from '../utils';
-import {XDSIcon} from '../Icon';
-import type {XDSBaseProps} from '../XDSBaseProps';
+} from '@xds/core/theme/tokens.stylex';
+import {xdsClassName, mergeProps} from '@xds/core/utils';
+import {XDSIcon} from '@xds/core/Icon';
+import type {XDSBaseProps} from '@xds/core';
import {useXDSStepperContext} from './XDSStepperContext';
export interface XDSStepProps extends XDSBaseProps<HTMLDivElement> {
diff --git a/packages/core/src/Stepper/XDSStepper.test.tsx b/packages/lab/src/Stepper/XDSStepper.test.tsx
similarity index 100%
rename from packages/core/src/Stepper/XDSStepper.test.tsx
rename to packages/lab/src/Stepper/XDSStepper.test.tsx
diff --git a/packages/core/src/Stepper/XDSStepper.tsx b/packages/lab/src/Stepper/XDSStepper.tsx
similarity index 97%
rename from packages/core/src/Stepper/XDSStepper.tsx
rename to packages/lab/src/Stepper/XDSStepper.tsx
index 413ff65c31..55e40668bd 100644
--- a/packages/core/src/Stepper/XDSStepper.tsx
+++ b/packages/lab/src/Stepper/XDSStepper.tsx
@@ -19,8 +19,8 @@
import {useMemo, type ReactNode} from 'react';
import * as stylex from '@stylexjs/stylex';
-import {xdsClassName, mergeProps} from '../utils';
-import type {XDSBaseProps} from '../XDSBaseProps';
+import {xdsClassName, mergeProps} from '@xds/core/utils';
+import type {XDSBaseProps} from '@xds/core';
import {
XDSStepperContext,
type XDSStepperOrientation,
diff --git a/packages/core/src/Stepper/XDSStepperContext.ts b/packages/lab/src/Stepper/XDSStepperContext.ts
similarity index 100%
rename from packages/core/src/Stepper/XDSStepperContext.ts
rename to packages/lab/src/Stepper/XDSStepperContext.ts
diff --git a/packages/core/src/Stepper/index.ts b/packages/lab/src/Stepper/index.ts
similarity index 100%
rename from packages/core/src/Stepper/index.ts
rename to packages/lab/src/Stepper/index.ts
diff --git a/packages/lab/src/index.ts b/packages/lab/src/index.ts
index 30115b373c..30e57db0f9 100644
--- a/packages/lab/src/index.ts
+++ b/packages/lab/src/index.ts
@@ -237,3 +237,5 @@ export {
type StreamGLOptions,
type StreamGLHandle,
} from './ChartV2';
+export * from './Stepper';
+export * from './CircularProgress';