/srm-ui

React components lib

Primary LanguageTypeScript

SRM-ui SRM组内组件封装

使用Typescript, React Hooks,基于material-ui,对基础组件以及业务组件进行进一步封装

How to use

dev

  1. 在此项目下运行
yarn link
  1. 在需要使用组件的测试项目下运行
yarn link srm-ui
  1. 测试项目可使用以下方式引用组件
import {Pager} from 'srm-ui';

npm

  1. npm 安装项目
npm install https://github.com/xiaobbaiha/srm-ui.git
  1. 测试项目可使用以下方式引用组件
import {Pager} from 'srm-ui';

Userful Scripts

增加组件自动化命令

会根据组件类型和组件名称创建文档以及源代码目录/文件,并更新README文档

npm run add ['basic'|'sprite'] [componentName]

'basic'代表基础组件 'sprite'代表业务组件 例1: 增加Button基础组件

npm run add basic Button

例2: 增加TaskList业务组件

npm run add sprite TaskList

基础组件

  1. 分页器 Pager Pager.md
  2. 表格 Table Table.md
  3. 弹窗 Modal Modal.md
  4. 通知 Notification Notification.md
  5. 空数据 Empty Empty.md
  6. 菜单 Menu Menu.md

业务组件

  1. 任务列表 TaskList TaskList.md