Skip to content

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

TypeScript

docs(indicator): untag @example JSDoc fences so Storybook autodocs renders them (#4911)

Ishan Jainbe0ba4a6db2b
diff --git a/packages/core/src/Indicator/CheckIndicator.tsx b/packages/core/src/Indicator/CheckIndicator.tsx
index 1223792f13..a9358b0142 100644
--- a/packages/core/src/Indicator/CheckIndicator.tsx
+++ b/packages/core/src/Indicator/CheckIndicator.tsx
@@ -48,14 +48,14 @@ const iconSizeForIndicator = {
* state, or focus behavior; the option or row that hosts it keeps all of that.
*
* @example
- * ```tsx
+ * ```
* <CheckIndicator state={isSelected ? 'checked' : 'unchecked'} size="sm" />
* ```
*
* Swap every single-selection mark for a radio:
*
* @example
- * ```tsx
+ * ```
* import {RadioIndicator} from '@astryxdesign/core/Indicator';
*
* defineTheme({name: 'brand', indicators: {check: RadioIndicator}});
diff --git a/packages/core/src/Indicator/CheckboxIndicator.tsx b/packages/core/src/Indicator/CheckboxIndicator.tsx
index 5318edf597..5e2a105036 100644
--- a/packages/core/src/Indicator/CheckboxIndicator.tsx
+++ b/packages/core/src/Indicator/CheckboxIndicator.tsx
@@ -166,7 +166,7 @@ const indeterminateSizeStyles = stylex.create({
* the `checkbox` theme target like any other component.
*
* @example
- * ```tsx
+ * ```
* <CheckboxIndicator state="indeterminate" size="sm" />
* ```
*/
diff --git a/packages/core/src/Indicator/RadioIndicator.tsx b/packages/core/src/Indicator/RadioIndicator.tsx
index a7b134c968..426552011e 100644
--- a/packages/core/src/Indicator/RadioIndicator.tsx
+++ b/packages/core/src/Indicator/RadioIndicator.tsx
@@ -134,7 +134,7 @@ const dotSizeStyles = stylex.create({
* components whose default is "a checkmark when selected, nothing otherwise".
*
* @example
- * ```tsx
+ * ```
* <RadioIndicator state="checked" size="md" />
* ```
*/
diff --git a/packages/core/src/Indicator/indicatorRegistry.ts b/packages/core/src/Indicator/indicatorRegistry.ts
index 0ac921727a..7bffb6205b 100644
--- a/packages/core/src/Indicator/indicatorRegistry.ts
+++ b/packages/core/src/Indicator/indicatorRegistry.ts
@@ -85,7 +85,7 @@ function getThemeIndicators(
* the {@link useIndicator} hook, which resolves against the nearest `<Theme>`.
*
* @example
- * ```tsx
+ * ```
* const Radio = getIndicator('radio', themeName);
* <Radio state="checked" />
* ```
@@ -95,7 +95,7 @@ function getThemeIndicators(
* added the name owns its default:
*
* @example
- * ```tsx
+ * ```
* const Star = getIndicator('brand-star', themeName) ?? BrandStar;
* ```
*/
diff --git a/packages/core/src/Indicator/useIndicator.ts b/packages/core/src/Indicator/useIndicator.ts
index 326bb0331a..bed35a07ff 100644
--- a/packages/core/src/Indicator/useIndicator.ts
+++ b/packages/core/src/Indicator/useIndicator.ts
@@ -21,7 +21,7 @@ import type {IndicatorComponent, IndicatorMap, IndicatorName} from './types';
* `| undefined` — see {@link getIndicator}.
*
* @example
- * ```tsx
+ * ```
* const Checkbox = useIndicator('checkbox');
* return <Checkbox state={isChecked ? 'checked' : 'unchecked'} size={size} />;
* ```