Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP 🚧
Closes #15748
Move to stable checklist
Requirements to move to stable
API/implementation
(~3 months) in aim to catch potential defects with spec, implementation,
accessibility, etc.
src/index.js
and should not beunstable_
prefixed
forwardRef
propTypes
PropTypes.shape
overPropTypes.object
if possiblepropTypes
in defaultProps)
onClick = () => {}
can cause re-renders since the function identityis not stable
<ComponentName>.stories.js
the most common use-cases
be hidden from the controls panel, eg.
className
node
with no proper controls available forconfiguration should be hidden from the controls panel, eg.
children
.mdx
document that@testing-library/react
thatcover the entire component API
e2e/components/ComponentName/ComponentName-test.e2e.js
that:autoAlign etc.) by setting controls/args on a story
e2e/components/ComponentName/ComponentName-test.avt.e2e.js
that:.toBeAccessible()
by arranging/interacting with component before calling
.toBeAccessible()
<ComponentName>.figma.tsx
file in the code-connect folder.@carbon/styles
ComponentName/_componentName.scss
file
@mixin
ComponentName/_index.scss
that has atminimum:
@forward 'componentName';
@use 'componentName';
@include componentName.componentName;