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

Jump to bottom

Add component props docs #60350

Merged
merged 3 commits into from Apr 2, 2024
Merged

Add component props docs #60350

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a33cbc8
add docs about component props
mikeybinns Apr 1, 2024
8b77819
Merge branch 'WordPress:trunk' into add-component-props-docs
mikeybinns Apr 1, 2024
d5b6f49
Apply suggestions from code review
mikeybinns Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/components/README.md
View file
Open in desktop
Expand Up @@ -57,6 +57,19 @@ const Example = () => {
};
```

### TypeScript

This package exposes its own types for the components it exports, however it doesn't export its own types for component props. If you need to extract the props type, please use `React.ComponentProps` to get the types from the element.

```tsx
import type { ComponentProps } from 'react';
import { Button } from '@wordpress/components';

export default function MyButton( props: ComponentProps< typeof Button > ) {
return <Button { ...props }>Click Me!</Button>;
}
```

## Docs & examples

You can browse the components docs and examples at [https://wordpress.github.io/gutenberg/](https://wordpress.github.io/gutenberg/)
Expand Down