Add documentation for rest props

WordPress · Dec 18, 2024 · 52300b3 · 52300b3
1 parent f3ab0c2
commit 52300b3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/packages/components/src/badge/README.md b/packages/components/src/badge/README.md
@@ -20,3 +20,7 @@ Badge variant.
  - Type: `"default" | "info" | "success" | "warning" | "error"`
  - Required: No
  - Default: `default`
+
+### `Additional Props`
+
+ - Any other props will be passed down to the underlying `span` element
diff --git a/packages/components/src/badge/stories/index.story.tsx b/packages/components/src/badge/stories/index.story.tsx
@@ -13,6 +13,22 @@ const meta = {
 	title: 'Components/Containers/Badge',
 	id: 'components-badge',
 	tags: [ 'status-private' ],
+	args: {
+		children: 'Code is Poetry',
+		intent: 'default',
+		// @ts-ignore
+		'...props': null,
+	},
+	argTypes: {
+		// @ts-ignore
+		'...props': {
+			control: {
+				type: null,
+			},
+			description:
+				'Any other props will be passed down to the underlying `span` element',
+		},
+	},
 } satisfies Meta< typeof Badge >;
 
 export default meta;