Установка

npm install @itd-social/itd-ui

yarn add @itd-social/itd-ui

pnpm add @itd-social/itd-ui

Не забудь подключить стили:

import '@itd-social/itd-ui/styles.css';

Быстрый старт

import { AppRoot, Button, ConfigProvider, Flex, Placeholder } from '@itd-social/itd-ui';
import '@itd-social/itd-ui/styles.css';
 
export function App() {
  return (
    <ConfigProvider colorScheme="dark">
      <AppRoot>
        <Placeholder
          title="Добро пожаловать в ИТД UI"
          description="Набор готовых React-компонентов для платформы ИТД."
          action={
            <Flex gap="sm">
              <Button variant="primary" onClick={() => window.open('https://ui.итд.tech', '_blank')}>
                Документация
              </Button>
              <Button variant="secondary" onClick={() => window.open('https://github.com/itd-social/ITD-UI', '_blank')}>
                GitHub
              </Button>
            </Flex>
          }
        />
      </AppRoot>
    </ConfigProvider>
  );
}

Компоненты

Полный каталог компонентов, их пропсов и интерактивные примеры — в Storybook:

bun run storybook

Откроется на http://localhost:6006.

Разработка

git clone https://github.com/itd-social/ITD-UI.git
cd ITD-UI
bun install

bun run storybook      # UI-каталог для разработки
bun run lint           # eslint
bun run build          # сборка dist/ (rollup)
bun run generate       # сгенерировать новый компонент по шаблону (plop)

Подробнее о процессе разработки — в dev.md, о релизах — в RELEASING.md.

Лицензия

MIT