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

docs: Do not use defaultProps #1766

Closed
wants to merge 1 commit into from
Closed

docs: Do not use defaultProps #1766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/pages/components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Components should generally be crafted using the following standards. There may
- Primitive/Pattern components should always use `React.forwardRef` to provide direct access to the component's primary element
- All components should include a `displayName`
- All components should be functional (i.e. do not use class components)
- All components may not rely on `defaultProps` and should use default parameters instead
- All components should be named using [Pascal case](https://en.wiktionary.org/wiki/Pascal_case)
- All components should include typescript types for component props
- Polymorphic components should support using `as` property providing the capability for components to render as a different component under the hood
Expand All @@ -46,4 +47,4 @@ Additionally, components should be operable using the following screen readers:
- NVDA
- JAWS

Cauldron aims to provide accessible components by default with minimal configuration.
Cauldron aims to provide accessible components by default with minimal configuration.
Loading