npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

@clcorp/react-ui

0.1.35 • Public • Published

UI Kit

Quick start

$ git clone https://box.itpark.space/gitlab/it.park/react_ui_kit.git
cd react_ui_kit
$ yarn
$ yarn docz:dev

Команды

  • commit для совершения коммита по стандарту
  • docz:dev для сборки документации в dev режиме
  • docz:build для сборки production версии документации
  • build для сборки самой библиотеки

API компонентов

  • API компонентов, дублирующих нативные элементы должен быть максимально близок с аттрибутами HTML элементов т.е. onChange проп для Input'ов, onClick для кнопок и т.д.
  • Все функции-хэндлеры начинаются с handle
  • Назания аттрибутов
    • Boolean - прилагательные
    • Enum'ы - существительные
    • обработчики - начинаются с on
  • Цвета
    • Название цвета - его однозначный идентификатор
    • Название не содержит в себе варианты использования и вообще достаточно абстрактно
      • link-color - плохо
      • red-link-hover-color - очень плохо
      • dark-red, light-blue - хорошо
      • base1, base_700 - в случае сильной темизации

Архитектура директорий

  • src
    • components
      • Группа компонентов (Buttons)
        • Директория компонента (OutlinedButton)
          • Component.mdx
          • Component.jsx
          • Component.spec.js, если понадобится
    • utils
      • Директории по месту использованию функционала (colors и т.д.)

Keywords

none

install

npm i @clcorp/react-ui

Downloadsweekly downloads

39

version

0.1.35

license

ISC

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability