Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature : Components Documentation for "rest props" #68099

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open

Feature : Components Documentation for "rest props" #68099

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52300b3
Add documentation for rest props
Vrishabhsk Dec 18, 2024
19d6bce
Handle Additional Props heading - README generation
Vrishabhsk Dec 24, 2024
8f259ca
Add additionalProps field to auto-generation schema - README
Vrishabhsk Dec 24, 2024
5ea5f29
Demonstrate new auto-generation - README and update storybook
Vrishabhsk Dec 24, 2024
98338ed
Merge branch 'trunk' into add/document-rest-props
Vrishabhsk Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/components/src/badge/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ Badge variant.
- Type: `"default" | "info" | "success" | "warning" | "error"`
- Required: No
- Default: `default`

### `Additional Props`
Vrishabhsk marked this conversation as resolved.
Show resolved Hide resolved

- Any other props will be passed down to the underlying `span` element
16 changes: 16 additions & 0 deletions packages/components/src/badge/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Vrishabhsk marked this conversation as resolved.
Show resolved Hide resolved
argTypes: {
// @ts-ignore
Vrishabhsk marked this conversation as resolved.
Show resolved Hide resolved
'...props': {
Vrishabhsk marked this conversation as resolved.
Show resolved Hide resolved
control: {
type: null,
},
Vrishabhsk marked this conversation as resolved.
Show resolved Hide resolved
description:
'Any other props will be passed down to the underlying `span` element',
Vrishabhsk marked this conversation as resolved.
Show resolved Hide resolved
},
},
} satisfies Meta< typeof Badge >;

export default meta;
Expand Down
Loading