-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Closed
Labels
area-UIRelating to the user interface.Relating to the user interface.team-design-systemAll issues relating to design system in ExtensionAll issues relating to design system in Extension
Description
Description
Ensure that PickerNetwork adheres to all of the following conventions and standards
- Has a
classNameprop and the PropType descriptions are all the same - Prop table in MDX docs have the "Accepts all Box component props" description and link
- We are consistent when using the same prop names like
sizeand are suggesting the use of the generalizeddesign-system.jsconstants e.g.SIZESas the primary option but noting the component consts in the documentation and using them for propType validation and storybook controls only - Standardize all similar prop names for images
imgSrc,imgAlt(html element + attribute) (needs audit) - We have a story for each component prop and we use the prop name verbatim e.g.
sizeprop would beexport const Size = (args) => ( - We have the accompanying documentation for each component prop and we use the prop name verbatim e.g.
sizeprop would be### Size - Are multiple props stories allowed? e.g.
Color, Background Color And Border Colorstory inbase-avatar- [ ] yes when it makes sense to - All Base components follow the suffix convention e.g.
ButtonBase - All Base component MDX documentation have the base component notification at the top
- Add
mm-prefix to all classNames - className is kebab case version of the component name
- Spread base components props and reduce duplication of props when props aren't being changed and remain the same for both variant and base components
- Add component to root
index.jsfile in component-library - Add locals for any default text I18nContext as default context
- Add any "to dos" with a
// TODO:comment so we can search for them at a later date e.g. blocking components etc - Add snapshot testing
- Add pixel values to propType descriptions if we use abstracted prop types that relate to pixel values e.g.
SIZE.MD (32px) - Each prop section in the MDX docs should have: a heading, a description, a story and an example code snipped
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area-UIRelating to the user interface.Relating to the user interface.team-design-systemAll issues relating to design system in ExtensionAll issues relating to design system in Extension