@brwn/ui-kit
v1.0.62
Published
UI Kit for BRWN RM Tool
Readme
Resources automation project: UI Kit
This repository contains source code for UI Kit. The UI Kit contains different components: buttons, inputs, icons, cards and so on.
Take a quick look
This project is supported with Storybook. Storybook is a tool that shows all the components as stories. To run storybook, please run
yarn run storybook
Available scripts
yarn run build
This script builds the app using webpack configuration
yarn run add ComponentName
This script adds a component to UI Kit. This component will be provided with all the predefined structure, types, interfaces, styles etc. It's needed for making the repository structure as clean as possible.
Default theme
#B6D057: Primary#DE350B: Secondary#5243AA: Third#FF991F: Fourth#F8B6C3: Fifth#0052CC: Sixth#8F92A1: Seventh#F3F6F8: Eighth#FFFFFF: Ninth#000000: Tenth
UI Icons
Description
Use <Icon iconName="icon_name"/> to render an icon React component
All icon names you can find here
Properties
| Props | Type | Required | Values | Default | Description |
| ----------- | -------- | :------: | --------------------------------------------------------------------------------- | --------- | ------------------------- |
| iconName | string | * | Icon name from here | | Defines an icon |
| size | string | | 'small', 'default', 'large' | 'default' | Specifies the icon size |
| color | string | | 'primary', 'secondary', 'error' | 'primary' | Specifies the icon color |
