@slush_dev/ui

Contribution guidelines:

• Each component are a folder contains the following files (note the camel cases)
  1. {ComponentName}.tsx
  2. {ComponentName}.stories.tsx (optional)
  3. {ComponentName}.styles.ts (optional)
  4. {ComponentName}.specs.ts (optional)
  5. index.ts

(1) is the main component file. Use export default!

(2) is the stories file. This will not be built and bundled with the library. Do not write components here. Only for stories.

(3) is the styles file. This might not or might not needed, if the component does not have any use any styled-components for styling, or utility styled components that are used accompanied with the main component. Try to minimized the number of exports. Only export what is needed and intended to be used by the library's consumer.

(4) is the specs file. This might be used for writing tests. (WIP)

(5) Important! The entry point of the component is the index.ts file. Import and export the necessary API for the component here.

• For examples of a button, see src/components/Button/*.{ts,tsx}