@consta/analytic-ui
v2.0.0
Published
Компоненты для аналитики и обратной связи, входят в [дизайн-систему Consta](https://github.com/consta-design-system/uikit).
Downloads
8
Keywords
Readme
Дизайн-система Consta | Analytic UI
Компоненты для аналитики и обратной связи, входят в дизайн-систему Consta.
Как использовать
Установите пакет
# NPM
$ npm install @consta/analytic-ui
# Yarn
$ yarn add @consta/analytic-ui
Подключите зависимости
Чтобы начать работу, установите библиотеку @consta/uikit
и настройте тему.
Можно использовать компоненты
Например, так:
import { Theme, presetGpnDefault } from '@consta/uikit/Theme';
import { FeedbackForm } from '@consta/FeedbackForm';
import { Button } from '@consta/Button';
export const FeedbackFormExampleTypeNps = () => {
const [isOpen, setIsOpen] = useState < boolean > false;
return (
<>
<FeedbackForm
label="Как вам наш модуль по созданию сценариев?"
type="NPS"
isOpen={isOpen}
onClose={() => setIsOpen(false)}
/>
<Button label="Открыть виджет" onClick={() => setIsOpen(true)} />
</>
);
};
Документация
Посмотреть документацию и примеры
Разработка
Подготовка окружения
Рабочее окружение должно содержать NodeJS и Yarn.
Чтобы установить зависимости, выполните команду:
$ yarn install
Основные команды
# Запуск локального сервера для разработки
$ yarn start
# Сборка пакета
$ yarn build
# Сборка стенда
$ yarn stand:build
# Запуск тестов
$ yarn test
Контрибьюторам
Будем рады, если вы захотите принять участие в разработке дизайн-системы =) Но сначала прочитайте инструкцию для контрибьюторов.
Лицензия
Дизайн-систему можно использовать бесплатно, она распространяется на условиях открытой лицензии MIT.