brink-components v0.1.3

Brink Components

React components of Brink design system.

Packages and tools

We are using:

• Typescript for type safety,
• MUI as utility components library with styled components for its style engine,
• Storybook for components showcase and documentation,
• Testing Library and Jest for testing.

What is inside this project

Components

Contain all reusable components used throughout Brink apps.

Structure

Following folder structure is enforced:

├── components
│   ├── ComponentName
│   │   ├── ComponentName.tsx
│   │   ├── ComponentName.spec.tsx
│   │   ├── ComponentName.stories.tsx

Exporting components

All components are exported in index.tsx file.

Stories

Storybook files not connected to a particular component, eg. colors preview.

Styles

Styles and theme related files, eg. MUI theme setup.