前置要求:由于组件库使用dumi开发,需要对dumi有初步了解
符合公司前端开发规范
组件文档必选项
- 使用场景,为什么会有这个组件,它解决了哪一类需求
- demo展示,这个组件怎么用,效果是怎样的,如果有多种场景,请尽量列举
- 参数说明:非常重要,你和用户交流的主要文档,入参数据格式、是否必传、默认值、支持版本等尽量完善
- 测试用例:测试用例必不可少,组件库一般采用jest + enzyme方案;todo 测试用例怎么写
组件开发建议
- 由于我们是基于antd开发的组件库,因此入参如有必要请继承atnd的属性,组件内可以把传入的rest props 完全的传入antd组件;公司组件库有引入ts,开发时入参如有必要请继承antd的属性,方便使用组件库时有相关的提示信息
- 引入三方库时候,如果是antd、react或者公司项目中已经引入的,请不要作为dependencies引入组件库中,开发时可以作为devDependencies引入,同时在peerDependencies进行声明,防止组件库体积过大
- 参数命名建议:尽量与antd保持一致,见名知意 https://developer.mozilla.org/zh-CN/docs/Web/API/Element#methods
- 要提炼组件前,可以业务群里面先发下预览效果,沟通一下
- 版本管理,https://docs.npmjs.com/about-semantic-versioning

