react-c2-common

reactc2 前端组件库

tips:

• 文档中涉及 OK、必填等确认性的，使用：✅
• 文档中涉及 NO、必填等非确认性的，使用✖

Usage

TODO

Options

TODO

Development

# install dependencies
$ npm install

# develop library by docs demo
$ npm start

# build library source code
$ npm run build

# build library source code in watch mode
$ npm run build:watch

# build docs
$ npm run docs:build

# check your project for potential problems
$ npm run doctor

Docker 部署

1. docker build -t react-c2-common .
2. docker run -d -p 3001:3001 react-c2-common

LICENSE

MIT 数据共享使用 hox

注意

本地开发时，涉及到下载文件，请先运行 npm run docs:build ，否则会出现浏览器崩溃

文件下载

• 需要下载的文件添加到 docs/files/xxx/${version}下
• 在 md 文件头部添加配置：

versionConfig:
    {
        fileTypes: ['js','ts'], # 文件支持下载的类型
        fileDir: 'jsapis', # 文件存放路径，相对：docs/files/
        fileName: 'c2mobile', # 注意这里仅需要配置前缀，模板中会根据js文件类型，自动加上JSSDK-${version}的配置
    }
versions:
  [
    {
      version: 0.0.1,
      desc: 'ts文件中包含ts类型，并已导出openLink函数',
      fileName: 'c2mobile', # 会覆盖versionConfig中的fileName配置，一般情况下这个不配置
    },
  ]

• md 文件中添加全局组件 <FileTable></FileTable>