@project-1114/ui-kit
Version:
ui-kit for project-1114
64 lines (47 loc) • 2.36 kB
Markdown
## The purpose of this library
ui-kit for the Project-1114
## Setup
- `npm install --save-dev @project-1114/ui-kit@latest` - add the lib into your react app.
## Build of the project
- `npm install` - install the all node modules from package.json;
- `npm run build:prod` - build in production mode;
- `npm run build:dev` - build in development mode (+ run parallel process bundle analyzer);
- `npm run storybook:build` - build the all stories for each UI-component;
- `npm run lint:ts:fix` - check and fix all ESLint errors;
- `npm run lint:scss:fix` - check and fix all Stylelint errors.
## Run the storybook
- `npm run storybook` - run the showcase for all UI-components.
## UI-components
### components
- [Button](/docs/ui-components/controls/Button.md)
- [TextField](/docs/ui-components/controls/TextField.md)
- [TextFieldPassword](/docs/ui-components/controls/TextFieldPassword.md)
- [TextArea](/docs/ui-components/controls/TextArea.md)
- [Checkbox](/docs/ui-components/controls/Checkbox.md)
- [RadioGroup](/docs/ui-components/controls/RadioGroup.md)
- [Switcher](/docs/ui-components/controls/Switcher.md)
- [Slider](/docs/ui-components/controls/Slider.md)
- [Link](/docs/ui-components/controls/Link.md)
- [Dropdown](/docs/ui-components/controls/Dropdown.md)
- [ListBox](/docs/ui-components/controls/ListBox.md)
- [Popover](/docs/ui-components/controls/Popover.md)
- [Skeleton](/docs/ui-components/shared/Skeleton.md)
- [Text](/docs/ui-components/shared/Text.md)
- [Card](/docs/ui-components/shared/Card.md)
- [Stack](/docs/ui-components/shared/Stack.md)
- [AppImage](/docs/ui-components/shared/AppImage.md)
- [Icon](/docs/ui-components/shared/Icon.md)
### widgets
- [ProgressBar](/docs/ui-components/widgets/ProgressBar.md)
- [Table](/docs/ui-components/widgets/Table.md)
- [Tape](/docs/ui-components/widgets/Tape.md)
- [Navbar](/docs/ui-components/widgets/Sidebar.md)
- [Accordion](/docs/ui-components/widgets/Accordion)
### utils
- [Alert](/docs/ui-components/utils/Alert.md)
- [Modal](/docs/ui-components/utils/Modal.md)
- [ModalConfirm](/docs/ui-components/utils/ModalConfirm.md)
- [Notification](/docs/ui-components/utils/Notification.md)
- [Window](/docs/ui-components/utils/Window.md)
## Dynamic names of classes for elements
- [classNames](/docs/libs/classNames.md)