Tea 框架 - 组件库
文档 & 示例
组件用法可参考 http://tea.tencent.com/component
组件目录
组件升级还在进行中,进度如下(🏃 进行中 📌 已计划 🕒 暂时挂起):
- 通用
- 布局
- 导航
- 展示
- 输入
- 交互
- 工具
- 业务相关
- 其他
- 工具方法
- 不推荐使用
开发
本地开发
前往 tea-web
目录,执行 npm install
完成依赖安装,然后执行 npm run start
,即可在本地运行起 Tea 文档站点。
新建组件
如需新建组件,请先在上文 组件目录 中添加组件说明,并建立相对应的目录。
README.md
网站中组件示例由 tea-component/src/
下各组件目录中 README.md
生成,一个 README.md
的示例如下:
# Button 按钮
提供标准的按钮交互和样式。
## 使用示例
<!-- <Half> -->
### 主要按钮
主按钮是用户在整个页面需要关注的优先级最高的操作,或者是我们需要最想要引导用户关注的操作。
[Example: 主要按钮](./_example/PrimaryButton.jsx)
<!-- </Half> -->
## 组件属性
[Interface: ButtonProps](./Button.tsx)
git 相关
分支
请基于 release
分支来进行开发,开发完成后请提交 Merge Request 到该分支。
提交注释
请参考提交注释规范
发布
构建
执行 npm run build
进行构建。
版本号更新
执行 npm version patch
更新末位版本号。
如需发布非 @latest
版本,请修改对应标签版本号,如 2.0.0-beta.1
。
发布至 TNPM
执行 tnpm publish
发布包。
如需发布非 @latest
版本,请添加 --tag
参数,如 tnpm publish --tag beta
。