@consta/charts

1.0.0 • Public • Published

Дизайн-система Consta | Библиотека графиков

Consta — дизайн-система для разработки интерфейсов, написана на React.

В дизайн-систему входит несколько библиотек. В этом репозитории — библиотека графиков: линейные, столбчатые, круговые диаграммы и другие компоненты, с помощью которых удобно показывать статистику. Библиотека сделана на основе G2Plot, добавлена стилизация для Consta.

Все библиотеки представлены в виде компонентов и макетов в Figma.

Что входит в дизайн-систему

Библиотека компонентов

Репозиторий | NPM | Документация и стенд | Макеты

Библиотека графиков

В этом репозитории | NPM | Документация и стенд | Макеты

>> Посмотреть все библиотеки


Подробности — на сайте дизайн-системы Consta

Следите за новостями и релизами в телеграм-канале дизайн-системы

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

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

# NPM
$ npm i @consta/charts
# Yarn
$ yarn add @consta/charts

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

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

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

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

import { Theme, presetGpnDefault } from '@consta/uikit/Theme';
import { Pie, PieProps } from '@consta/charts/Pie';
export const data = [
  { type: 'Option-1', value: 27 },
  { type: 'Option-2', value: 25 },
  { type: 'Option-3', value: 18 },
  { type: 'Option-4', value: 15 },
  { type: 'Option-5', value: 10 },
  { type: 'Option-6', value: 5 },
];
const MyComponent = () => {
  const options: PieProps = {
    appendPadding: 10,
    data,
    angleField: 'value',
    colorField: 'type',
    radius: 1,
    label: {
      type: 'inner',
      offset: '-50%',
      content: '{value}',
      style: {
        textAlign: 'center',
        fontSize: 14,
      },
    },
  };
  return (
    <Theme preset={presetGpnDefault}>
      <Pie {...options} />
    </Theme>
  );
};

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

На стенде можно посмотреть примеры графиков. Документация — во вкладке у каждого компонента.

Вперёд, к стенду

Разработка

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

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

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

$ yarn install

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

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

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

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

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

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

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

Лицензия

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

Readme

Keywords

none

Package Sidebar

Install

npm i @consta/charts

Weekly Downloads

473

Version

1.0.0

License

none

Unpacked Size

252 kB

Total Files

196

Last publish

Collaborators

  • miocene
  • fooontic
  • gizeasy
  • design-gazprom-neft