@consta/tree
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

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

Этот адаптер стилизует дерево rc-tree для дизайн-системы Consta.

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

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

# NPM
$ npm install @consta/rc-tree-adapter

# Yarn
$ yarn add @consta/rc-tree-adapter

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

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

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

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

import { Theme, presetGpnDefault } from '@consta/uikit/Theme'
import { default as RCTree } from 'rc-tree'
import { rcTreeAdapter } from '@consta/rc-tree-adapter/rcTreeAdapter'

const data = [
  {
    key: '0-0',
    title: 'Ветка 1',
    children: [
      { key: '0-0-0', title: 'Ветка 1-1', children: [{ key: '0-0-0-0', title: 'Ветка 1-1-0' }] },
      {
        key: '0-0-1',
        title: 'Ветка 1-2',
        children: [
          { key: '0-0-1-0', title: 'Ветка 1-2-0' },
          { key: '0-0-1-1', title: 'Ветка 1-2-1', disableCheckbox: true },
          { key: '0-0-1-2', title: 'Ветка 1-2-2' },
          { key: '0-0-1-3', title: 'Ветка 1-2-3' },
          { key: '0-0-1-4', title: 'Ветка 1-2-4' },
          { key: '0-0-1-5', title: 'Ветка 1-2-5' },
          { key: '0-0-1-6', title: 'Ветка 1-2-6' },
          { key: '0-0-1-7', title: 'Ветка 1-2-7' },
          { key: '0-0-1-8', title: 'Ветка 1-2-8' },
          { key: '0-0-1-9', title: 'Ветка 1-2-9' },
        ],
      },
    ],
  },
]

const App = () => {
  const treeProps = rcTreeAdapter({ size: 's' })

  return <RCTree {...treeProps} treeData={data} defaultExpandAll height={100} showIcon />
}

или так:

import { Theme, presetGpnDefault } from '@consta/uikit/Theme'
import { default as RCTree } from 'rc-tree'
import { cnRcTree } from '@consta/rc-tree-adapter/RcTree'

const Example = () => {
  const prefix = cnRcTree(
    {
      size: 's',
    },
    ['CustomTree']
  )

  return <RCTree treeData={data} prefixCls={prefix} defaultExpandAll />
}

Разработка

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

Рабочее окружение должно содержать NodeJS и Yarn, необходимые версии можно узнать в файле package.json в блоке engines.

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

$ yarn install

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

# Сборка и старт Storybook
$ yarn start

# Сборка для production
$ yarn build

# Линтинг всех файлов
$ yarn lint

# Форматирование всех файлов prettier
$ yarn format

# Запуск юнит-тестов
$ yarn unit

# Запуск юнит-тестов, тестирование TS, линтинг файлов
$ yarn test

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

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

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

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

Лицензия

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

Readme

Keywords

none

Package Sidebar

Install

npm i @consta/tree

Weekly Downloads

1

Version

1.0.2

License

none

Unpacked Size

17.9 kB

Total Files

27

Last publish

Collaborators

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