# 开发流程

# 流程图

下图为组件完整的开发流程,组件维护更新时,可能只需要部分流程即可。

# 组件代码开发

  1. 用微信开发者工具打开单仓下目录library/tms-ui/src (opens new window) ,如果没开发者权限则自己改为测试号即可;
  2. 在components中对应组件目录下实现组件功能,支持js、ts、css、less,建议 ts + less;如果是新组件还需要添加demo页;

开发规范请查阅组件开发规范

# 文档及demo页开发

# 文档开发

  1. 在组件根目录下创建README.me文件,即展示网站该组件的文档页。
  2. 参照基础组件的格式完成文档内容,如button组件(components/button/README.md)。

文档开发规范请查阅组件文档规范

# demo页开发

  1. 在app.json中注册demo页。
  2. 开发者工具打开demo页并实现demo,优先使用demo-block组件规范格式,特殊情况除外。
  3. 非行业组件,demo应当覆盖组件所有主要功能点。
  4. 如果涉及到截图,应当先上传到CDN。

# 更新config配置

该文件配置项如下:

module.exports = {
  items: [
    {
      name: 'ActionSheet 动作面板',                                // 体验版demo入口信息
      pathName: 'components/action-sheet/demos/index',            // 体验版页面路径
      export: {                                                   // 组件全局引用配置,可导出多个组件。
        'tms-action-sheet': 'components/action-sheet/index',      // 导出的组件名:组件路径
      },
    },
    ...
  ]
}
  1. 只有配置了export字段,对应组件代码才会发布到npm;
  2. 对于单仓下的小程序:对应的组件名,会自动注册到小程序的app.json,可以全局引用。

# 发布npm

代码合并后,需发布npm才能在代码中生效,请联系@webberlin(林伟波) 或 @logosdu(杜筱康)。

Last Updated: 9/24/2025, 15:34:55