@tmsfe/tms-ui

1.0.116 • Public • Published

组件开发流程

  1. 用微信开发者工具打开src目录,如果没开发者权限则自己改为测试号即可;
  2. 在components中对应组件目录下实现组件功能;
  3. 支持js、ts、css、less,建议 ts + less;
  4. 组件开发完之后,要在组件目录下的demos中增加使用示例,也可以用于开发过程调试;
  5. 组件的demos都已经添加到小程序的编译模式中,可以直接选择调试组件;
  6. 提交组件代码。

组件文档更新

  1. tmsui组件完成开发后,需要更新组件的README.md使用文档
  2. tmsui组件库每当触发merge master 的动作时,会自动触发脚本将组件的README.md文档更新组件平台。
  3. 组件平台的地址:https://open.go.qq.com/tmsui/
  4. README.md文档包含属性配置、使用指南、API、FAQ、CHANGELOG四部分,详见Button组件的README.md作为demo
  5. 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. 我的组件文档更新完成了,想在本地看一下文档的展示效果
1. 在tms-ui目录下执行 npm run docs:build 将组件Readme.md文件拷贝到 文档仓库的目录。
2. cd prod/tmsuidocs
3. npm install
4. npm run docs:dev

Readme

Keywords

none

Package Sidebar

Install

npm i @tmsfe/tms-ui

Weekly Downloads

69

Version

1.0.116

License

MIT

Unpacked Size

5.18 MB

Total Files

1890

Last publish

Collaborators

  • ppya0812
  • yimingfeng
  • addunt
  • xzq7
  • nifan950624
  • odilewang
  • tms_account
  • tmsgo