navattic-ui

To see all available components, please visit the Storybook.

Conventions

• Component that have sizes should have a default size of md and use the NvSize type.
• Components should not allow arbitrary functions to be passed in as props. Ex: Select could have allow the consumer to pass in a function filter which would decide which options get shown in the dropdown based on the search text. Instead, we've chosen to restrict the available options to a filterMode prop, which allows the consumer to choose from a set of pre-defined filter functions.

Reviews

Component

• Styles API supports necessary customization
• Maintain consistent DX across components
• className passed through properly
• Implements variants from design system?
• Has story showing a primary example
• Has story(ies) showing variants
• Story controls show all props intended for external use

Migration

• Was any logic changed?
• Was any styling changed?
• Deleted old component? If no, why not? Was it marked as deprecated?
• Were any intermediary styles added? If so, make a PR to remove them later

Migration TODOs:

• AvatarWithName and related Avatar components
• BoardsFilter