@quple-pos/header
v2.1.0
Published
Набор компонентов для создания шапки проекта.
Downloads
1
Readme
Дизайн-система Quple | Header
Набор компонентов для создания шапки проекта.
Как использовать
Установите пакет
# NPM
$ npm install @quple-pos/header
# Yarn
$ yarn add @quple-pos/header
Подключите зависимости
Чтобы начать работу, установите библиотеку @quple-pos/uikit
и настройте тему.
Можно использовать компоненты
Например, так:
import { Theme, presetGpnDefault } from '@quple-pos/uikit/Theme';
import { Header } from '@quple-pos/header';
const App = () => {
return (
<Theme preset={presetGpnDefault}>
<Header />
</Theme>
);
};
Документация
Посмотреть документацию и примеры
Разработка
Подготовка окружения
Рабочее окружение должно содержать NodeJS и Yarn.
Чтобы установить зависимости, выполните команду:
$ yarn install
Основные команды
# Запуск локального сервера для разработки
$ yarn start
# Сборка пакета
$ yarn build
# Сборка стенда
$ yarn stand:build
# Запуск тестов
$ yarn test
Контрибьюторам
Будем рады, если вы захотите принять участие в разработке дизайн-системы =) Но сначала прочитайте инструкцию для контрибьюторов.
Лицензия
Дизайн-систему можно использовать бесплатно, она распространяется на условиях открытой лицензии MIT.