pv-design
v1.0.8
Published
pvmed ui design
Downloads
472
Readme
pvmed/pv-design
柏视组件库
注意:
- 确保组件的向下兼容性,不要破坏现有功能:不缩减API,不改变旧API的定义,如有必要,请提供迁移方案。
- 保证组件增量更新。
- 保证组件的类型声明正确性。
介绍
技术栈说明
- 框架: React-ts(swc*) ○ 采用ts的原因是打包版本中可以继承antd-design的type定义,简化组件的类型声明,提高使用时的便利性 ○ eslint
- 打包工具: Vite(ESBuild) ○ 快速、简单
- 样式: 内联or style标签
- API文档生成: typedoc
- 组件demo:HTML(需要gitlab pages的支持)或MD
开发流程(新增组件)
- 创建组件:在 /components 目录下创建组件文件夹和文件。
- 编写文档:在 /src/template 目录下为每个组件编写使用文档(目录名称与components下的一致)。
- 组件命名约束:使用Pv拼接组件名,如:PvTabs
- 编译组件:npm run build
- 生成API文档:npm run build:doc
- 生成组件文档:npm run build:template
- 发布组件库:使用 npm publish 发布