Skip to content

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

TypeScript

docs(storybook): fix @example blocks that break autodocs (15 files) (#3927)

Joeyefe7cc3b7b0e
diff --git a/packages/core/src/AlertDialog/useImperativeAlertDialog.tsx b/packages/core/src/AlertDialog/useImperativeAlertDialog.tsx
index 0034fad574..fc61a76413 100644
--- a/packages/core/src/AlertDialog/useImperativeAlertDialog.tsx
+++ b/packages/core/src/AlertDialog/useImperativeAlertDialog.tsx
@@ -36,7 +36,6 @@ export interface ImperativeAlertDialogReturn {
* @example
* ```
* const alert = useImperativeAlertDialog();
- *
* const handleDelete = () => {
* alert.show({
* title: 'Delete item?',
@@ -45,7 +44,6 @@ export interface ImperativeAlertDialogReturn {
* onAction: async () => { await deleteItem(); alert.hide(); },
* });
* };
- *
* return (
* <>
* <button onClick={handleDelete}>Delete</button>
diff --git a/packages/core/src/Lightbox/useLightbox.tsx b/packages/core/src/Lightbox/useLightbox.tsx
index f58a17ab8c..22044d4c5d 100644
--- a/packages/core/src/Lightbox/useLightbox.tsx
+++ b/packages/core/src/Lightbox/useLightbox.tsx
@@ -76,7 +76,6 @@ export interface UseLightboxReturn {
* @example
* ```
* const lightbox = useLightbox({ media: photos });
- *
* {photos.map((photo, i) => (
* <img
* key={photo.src}
diff --git a/packages/core/src/Link/Link.tsx b/packages/core/src/Link/Link.tsx
index 6ff2719813..de40aab54c 100644
--- a/packages/core/src/Link/Link.tsx
+++ b/packages/core/src/Link/Link.tsx
@@ -274,8 +274,6 @@ export interface LinkProps extends BaseProps<
* <Link href="/settings" color="secondary">Settings</Link>
* <Link href="/privacy" hasUnderline>Privacy Policy</Link>
* <Link label="Close dialog" href="/home"><Icon icon="x" /></Link>
- *
- * // Inline link inside text — inherits the surrounding type/size:
* <Text type="large">
* Read our <Link href="/terms" type="inherit">terms</Link> first.
* </Text>
diff --git a/packages/core/src/Overlay/useOverlay.tsx b/packages/core/src/Overlay/useOverlay.tsx
index 9b695b830c..7fdeb597ef 100644
--- a/packages/core/src/Overlay/useOverlay.tsx
+++ b/packages/core/src/Overlay/useOverlay.tsx
@@ -149,7 +149,6 @@ export interface UseOverlayResult {
* showOn: 'hover',
* content: <Button label="Quick view" variant="ghost" />,
* });
- *
* <Card ref={overlay.containerRef} {...overlay.containerProps}>
* <Layout content={...} />
* {overlay.element}
@@ -158,9 +157,7 @@ export interface UseOverlayResult {
*
* @example
* ```
- * // Callback mode — render on demand
* const overlay = useOverlay({ showOn: 'hover' });
- *
* <div ref={overlay.containerRef} {...overlay.containerProps}>
* <img src={src} />
* {overlay.renderOverlay(<Button label="Quick view" />)}
diff --git a/packages/core/src/Table/plugins/rowExpansion/useTableRowExpansion.tsx b/packages/core/src/Table/plugins/rowExpansion/useTableRowExpansion.tsx
index 183ba1ae09..eb000f8705 100644
--- a/packages/core/src/Table/plugins/rowExpansion/useTableRowExpansion.tsx
+++ b/packages/core/src/Table/plugins/rowExpansion/useTableRowExpansion.tsx
@@ -109,7 +109,7 @@ export interface UseTableRowExpansionStateResult<
* computing the expand-all state.
*
* @example
- * ```tsx
+ * ```
* const [expandedKeys, setExpandedKeys] = useState<Set<string>>(new Set());
* const {data, expansionConfig} = useTableRowExpansionState({
* baseData: tree,
diff --git a/packages/core/src/VisuallyHidden/VisuallyHidden.tsx b/packages/core/src/VisuallyHidden/VisuallyHidden.tsx
index 94a6ec0213..04d9556771 100644
--- a/packages/core/src/VisuallyHidden/VisuallyHidden.tsx
+++ b/packages/core/src/VisuallyHidden/VisuallyHidden.tsx
@@ -79,12 +79,9 @@ const styles = stylex.create({
*
* @example
* ```
- * // Accessible name for an icon-only button
* <IconButton icon="trash" label="">
* <VisuallyHidden>Delete incident</VisuallyHidden>
* </IconButton>
- *
- * // Live region for announcements
* <VisuallyHidden as="div" aria-live="polite">
* {`Moved ${task} to ${column}`}
* </VisuallyHidden>
diff --git a/packages/lab/src/Chart/ChartBrush.tsx b/packages/lab/src/Chart/ChartBrush.tsx
index 75ad488fc3..66127d6d5f 100644
--- a/packages/lab/src/Chart/ChartBrush.tsx
+++ b/packages/lab/src/Chart/ChartBrush.tsx
@@ -76,11 +76,8 @@ function localCoords(e: React.PointerEvent<SVGRectElement>): {
* Brush interaction for range selection.
*
* @example
- * ```tsx
- * // X-only (default)
+ * ```
* <ChartBrush onBrush={({x}) => setZoom(x)} />
- *
- * // 2D rectangular
* <ChartBrush mode="xy" onBrush={({x, y}, points) => setSelected(points)} />
* ```
*/
diff --git a/packages/lab/src/Chart/ChartCandlestick.tsx b/packages/lab/src/Chart/ChartCandlestick.tsx
index cec75596a5..ec0e09baf8 100644
--- a/packages/lab/src/Chart/ChartCandlestick.tsx
+++ b/packages/lab/src/Chart/ChartCandlestick.tsx
@@ -47,14 +47,11 @@ export interface ChartCandlestickProps {
*
* @example
* ```
- * // Financial OHLC
* <ChartCandlestick
* high="high" low="low" open="open" close="close"
* upColor={useChartColors().semantic.positive}
* downColor={useChartColors().semantic.negative}
* />
- *
- * // OHLC bar
* <ChartCandlestick
* variant="bar"
* high="max" low="min" open="q1" close="median"
diff --git a/packages/lab/src/Chart/ChartLegend.tsx b/packages/lab/src/Chart/ChartLegend.tsx
index e5c5ec13b8..b954943889 100644
--- a/packages/lab/src/Chart/ChartLegend.tsx
+++ b/packages/lab/src/Chart/ChartLegend.tsx
@@ -54,20 +54,15 @@ function toGradientCSS(colors: string[]): string {
*
* @example
* ```
- * // Discrete
* <ChartLegend items={[
* {label: 'Revenue', color: colors[0]},
* {label: 'Expenses', color: colors[1]},
* ]} />
- *
- * // Continuous — pipe useChartColors() directly
* <ChartLegend
* gradient={useChartColors().sequential.blue(5)}
* domain={[0, 100]}
* label="Temperature"
* />
- *
- * // Diverging
* <ChartLegend
* gradient={useChartColors().diverging.coldHot(7)}
* domain={[-50, 50]}
diff --git a/packages/lab/src/Chart/ChartTooltip.tsx b/packages/lab/src/Chart/ChartTooltip.tsx
index fa8ab3ea9c..d05953b26f 100644
--- a/packages/lab/src/Chart/ChartTooltip.tsx
+++ b/packages/lab/src/Chart/ChartTooltip.tsx
@@ -96,17 +96,10 @@ export interface ChartTooltipProps {
* in the top layer (via Popover API, portaled outside the SVG).
*
* @example
- * ```tsx
- * // Default: vertical crosshair + tooltip card
+ * ```
* <ChartTooltip />
- *
- * // Both axes, with labels
* <ChartTooltip crosshair="xy" crosshairLabels />
- *
- * // Tooltip only, no crosshair lines
* <ChartTooltip crosshair={false} />
- *
- * // Custom render
* <ChartTooltip render={(d) => <span>{d.month}: ${d.revenue}</span>} />
* ```
*/
diff --git a/packages/lab/src/CodeEditor/CodeEditor.tsx b/packages/lab/src/CodeEditor/CodeEditor.tsx
index e78bdcb4a3..5bdad77a89 100644
--- a/packages/lab/src/CodeEditor/CodeEditor.tsx
+++ b/packages/lab/src/CodeEditor/CodeEditor.tsx
@@ -181,7 +181,7 @@ let editorInstanceCounter = 0;
* auto-indent, tab insertion, and bracket auto-closing.
*
* @example
- * ```tsx
+ * ```
* const [code, setCode] = useState('');
* <CodeEditor
* label="Source code"
diff --git a/packages/lab/src/Radial/RadialChart.tsx b/packages/lab/src/Radial/RadialChart.tsx
index f649f625d1..b1aa54a6c3 100644
--- a/packages/lab/src/Radial/RadialChart.tsx
+++ b/packages/lab/src/Radial/RadialChart.tsx
@@ -61,19 +61,14 @@ export interface RadialChartProps {
*
* @example
* ```
- * // Spider
* <RadialChart data={data} axes={['speed', 'handling', 'comfort']} height={400}>
* <RadialGrid rings={5} />
* <RadialArea dataKey="modelA" color={colors[0]} />
* <RadialAxis />
* </RadialChart>
- *
- * // Pie
* <RadialChart data={data} valueKey="revenue" labelKey="region" height={400}>
* <RadialSlice />
* </RadialChart>
- *
- * // Donut
* <RadialChart data={data} valueKey="revenue" labelKey="region" innerRadius={0.6} height={400}>
* <RadialSlice />
* </RadialChart>
diff --git a/packages/lab/src/Radial/RadialTooltip.tsx b/packages/lab/src/Radial/RadialTooltip.tsx
index eec291313e..de70180add 100644
--- a/packages/lab/src/Radial/RadialTooltip.tsx
+++ b/packages/lab/src/Radial/RadialTooltip.tsx
@@ -55,7 +55,7 @@ export interface RadialTooltipProps {
* using polar coordinate math and renders a tooltip in the top layer.
*
* @example
- * ```tsx
+ * ```
* <RadialChart data={data} valueKey="revenue" labelKey="region" height={400}>
* <RadialSlice colors={colors} />
* <RadialTooltip />
diff --git a/packages/lab/src/Sankey/SankeyChart.tsx b/packages/lab/src/Sankey/SankeyChart.tsx
index acd4f3b84e..c619b52c2c 100644
--- a/packages/lab/src/Sankey/SankeyChart.tsx
+++ b/packages/lab/src/Sankey/SankeyChart.tsx
@@ -107,15 +107,14 @@ function resolveColumnCount(
* Width is responsive but enforces minColumnWidth — scrolls when needed.
*
* @example
- * ```tsx
+ * ```
* <SankeyChart
* nodes={nodes}
* links={links}
* columns={[
* {ids: ['a', 'b'], label: 'Source'},
* {ids: ['c', 'd'], label: 'Target'},
- * ]}
- * >
+ * ]}>
* <SankeyGrid />
* <SankeyLink />
* <SankeyNode />
diff --git a/packages/lab/src/Stepper/Step.tsx b/packages/lab/src/Stepper/Step.tsx
index f50b106c7a..e0f18379a7 100644
--- a/packages/lab/src/Stepper/Step.tsx
+++ b/packages/lab/src/Stepper/Step.tsx
@@ -430,7 +430,6 @@ const styles = stylex.create({
*
* @example
* ```
- * // Generic icon + semantic color
* <Step step={1} label="Payment" status="error" icon={<Icon icon="warning" />} />
* ```
*/