开发规范

组件开发规范

1. 不能引用npm模块，比如 import CoreObj from '@tmsfe/tms-core';请使用getApp获取tms对象。
2. 组件之间只能通过usingComponents调用，不能引用其它组件目录下的JS文件，比如 import demoFunc from '../popup/index.js';； usingComponents中注册的组件名须和该组件在export中定义的一致，如：

"usingComponents": {
    "tms-popup": "../popup/index"         // 请使用tms-popup 保持组件名全局统一。
  }

3. 组件代码文件命名使用index，即组件目录/index.(json|js|wxml|wxss)。
4. 严格遵循UI设计规范。
5. 严格遵循团队代码规范 (opens new window)

组件文档规范

1. tmsui (opens new window)组件库每当触发merge master的动作时，会自动触发脚本将组件的README.md文档更新至组件库官网。
2. README.md文档一般包含这几个部分：front-matter属性配置、介绍、使用指南、API、EVENTS、CSS变量、FAQ；根据组件实际情况填充相应内容。 参照Button (opens new window)组件的README.md
3. 属性配置会指导该组件的文档按照什么规则部署到组件平台：

---
publish: on  // 是否在展示网站显示该组件信息及文档； on: 是(默认值)  off: 否
/**
 *  组件是什么类型；目前组件的类型包含：
 *  basic：基础组件(默认值)  
 *  form：表单组件 
 *  feedback：反馈组件 
 *  navigation：导航组件 
 *  display：展示组件
 *  industry：行业组件  
 */
type: basic
/**
 *  组件的排序, 0(Button)在组件平台中排序第一个。
 *  如果你开发的组件想插入到A、B组件之间，只需修改sort的值大于A的sort, 小于B的sort。(sort值支持小数点)
 */
sort: 2
---

4. 使用指南

• 使用指南中以功能为单位，分别填入各个功能的demo示例，包括js/html/css等代码。
• 使用demoBlock组件包裹每个功能点，代码将自动被伸缩卡片包裹，并有更好的排版效果， 参考Button组件的README.md (opens new window)