@consta/gantt-task-react-adapter
v2.0.0
Published
Этот адаптер стилизует диаграмму Ганта [gantt-task-react](https://github.com/MaTeMaTuK/gantt-task-react) для [дизайн-системы Consta](https://consta.design/).
Downloads
104
Keywords
Readme
Дизайн-система Consta | gantt-task-react-adapter
Этот адаптер стилизует диаграмму Ганта gantt-task-react для дизайн-системы Consta.
Как использовать
Установите пакет
# NPM
$ npm install @consta/gantt-task-react-adapter
# Yarn
$ yarn add @consta/gantt-task-react-adapter
Подключите зависимости
Чтобы начать работу, установите библиотеку @consta/uikit
и настройте тему.
Можно использовать компоненты
Например, так:
import React from 'react'
import { Theme, presetGpnDefault } from '@consta/uikit/Theme'
import { Gantt, Task } from 'gantt-task-react'
import { useGanttTaskReactAdapter } from '@consta/gantt-task-react-adapter/useGanttTaskReactAdapter'
const data: Task[] = [
{
start: new Date(currentDate.getFullYear(), currentDate.getMonth(), 1),
end: new Date(currentDate.getFullYear(), currentDate.getMonth(), 15),
name: 'Some Project',
id: 'ProjectSample',
progress: 25,
type: 'project',
hideChildren: false,
},
{
start: new Date(currentDate.getFullYear(), currentDate.getMonth(), 1),
end: new Date(currentDate.getFullYear(), currentDate.getMonth(), 2, 12, 28),
name: 'Idea',
id: 'Task 0',
progress: 45,
type: 'task',
project: 'ProjectSample',
},
...
]
const App = () => {
const styleOptions = useGanttTaskReactAdapter()
return <Gantt {...styleOptions} tasks={data} />
}
Документация
Посмотреть документацию и примеры
Разработка
Подготовка окружения
Рабочее окружение должно содержать NodeJS и Yarn.
Чтобы установить зависимости, выполните команду:
$ yarn install
Основные команды
# Запуск локального сервера для разработки
$ yarn start
# Сборка пакета
$ yarn build
# Сборка стенда
$ yarn stand:build
# Запуск тестов
$ yarn test
Контрибьюторам
Будем рады, если вы захотите принять участие в разработке дизайн-системы =) Но сначала прочитайте инструкцию для контрибьюторов.
Лицензия
Дизайн-систему можно использовать бесплатно, она распространяется на условиях открытой лицензии MIT.