@consta/stats

Дизайн-система Consta | Stats

Компонент для отображения чисел, например, на графиках, входит в дизайн-систему Consta. Подходит, чтобы красиво показывать числа для статистики.

Как использовать

Установите пакет

# NPM
$ npm install @consta/stats
# Yarn
$ yarn add @consta/stats

Подключите зависимости

Чтобы начать работу, установите библиотеку @consta/uikit и настройте тему.

Можно использовать компоненты

Например, так:

import { Theme, presetGpnDefault } from '@consta/uikit/Theme';
import { Stats } from '@consta/Stats';
const SomeComponent = () => (
  <Stats
    value={2170}
    title="Молний за год"
    unit="разрядов"
    rate="20%"
    iconArrowRate
    status="success"
  />
);

Документация

Посмотреть документацию и примеры

Разработка

Подготовка окружения

Рабочее окружение должно содержать NodeJS и Yarn.

Чтобы установить зависимости, выполните команду:

$ yarn install

Основные команды

# Запуск локального сервера для разработки
$ yarn start

# Сборка пакета
$ yarn build

# Сборка стенда
$ yarn stand:build

# Запуск тестов
$ yarn test

Контрибьюторам

Будем рады, если вы захотите принять участие в разработке дизайн-системы =) Но сначала прочитайте инструкцию для контрибьюторов.

Лицензия

Дизайн-систему можно использовать бесплатно, она распространяется на условиях открытой лицензии MIT.