@wildberries/root
v2.0.0-alpha.1
Published
library of ui components
Downloads
4
Keywords
Readme
@wildberries/ui-kit
Библиотека визуальных компонентов
Доступные команды
Запуск storybook:
npm run start
Запуск тестов:
npm run test
Запуск сборки:
npm run build
Установка
Для установки используйте команду npm:
npm install @wildberries/ui-kit
Или команду yarn:
yarn add @wildberries/ui-kit
Доступ к интерфейсу
Компоненты подключаются следующим образом
import { Button, Radio } from '@wildberries/ui-kit'
Разработка
Новые компоненты необходимо добавлять в папку src/elements
Вложенности внутри компонентов не должно быть.
// bad
elements
|-- input
|-- input-number
|-- radio-button
// good
elements
|-- input-number
|-- radio
Имя компонента должно соответствовать имени папки, в которой он находит
// bad
//index.ts
export { Radio } from './radio-button-group'
elements
|-- radio-button
// good
//index.ts
export { Radio } from './radio'
elements
|-- radio
// good
//index.ts
export { InputNumber } from './input-number'
elements
|-- input-number
Инструкция по деплою новой версии приложения
Инструкия по деплою новой версии можно посмотреть в файле проекта: RELEASE-PROCESS.md