@tmsfe/tms-ui
v1.0.127
Published
腾讯出行服务UI组件库
Downloads
296
Keywords
Readme
组件开发流程
- 用微信开发者工具打开src目录,如果没开发者权限则自己改为测试号即可;
- 在components中对应组件目录下实现组件功能;
- 支持js、ts、css、less,建议 ts + less;
- 组件开发完之后,要在组件目录下的demos中增加使用示例,也可以用于开发过程调试;
- 组件的demos都已经添加到小程序的编译模式中,可以直接选择调试组件;
- 提交组件代码。
组件文档更新
- tmsui组件完成开发后,需要更新组件的README.md使用文档
- tmsui组件库每当触发
merge master
的动作时,会自动触发脚本将组件的README.md文档更新组件平台。 - 组件平台的地址:https://open.go.qq.com/tmsui/
- README.md文档包含
属性配置、使用指南、API、FAQ、CHANGELOG
四部分,详见Button组件的README.md作为demo - README.md的
属性配置
会指导该组件的文档如何部署到组件平台
---
publish:on // 该README.md文件是否发布到组件平台; on: 发布 off: 不发布
type: basic // 组件是什么类型; 目前组件的类型包含:basic: 基础组件 industry: 行业组件
sort: 2 // 组件的排序, 0(Button)在组件平台中排序第一个。如果你开发的组件想插入到A、B组件之间,只需修改sort的值大于A的sort, 小于B的sort。(sort值支持小数点)
---
- 我的组件文档更新完成了,想在本地看一下文档的展示效果
1. 在tms-ui目录下执行 npm run docs:build 将组件Readme.md文件拷贝到 文档仓库的目录。
2. cd prod/tmsuidocs
3. npm install
4. npm run docs:dev