0.1.2 • Published 2 years ago
climb-ui-component v0.1.2
name: README
route: /readme
安装
在工程目录添加 .npmrc
:
registry=https://mirrors.tencent.com/npm/
或者
npm config set registry https://mirrors.tencent.com/npm/
开始使用
npm i --save @tencent/tea-component @tencent/sr-ui-component @tencent/tea-sr
引用皮肤
文档:http://tea-sr.pages.oa.com/
组件库 0.2.x 版本之后,tea-sr 必须升级到 1.1.x
// 皮肤样式
@import '~@tencent/@tencent/tea-sr/css/tea-sr.css';
贡献代码
环境
- 确保内网环境可访问:http://tnpm.oa.com/
- 项目根目录
npm i
; - 执行:
npm run dev
,访问 http://localhost:3000 - 使用 VS code,并安装 ESLint 和 Prettier 扩展
目录规范
- 统一放在
src/componets
目录下 - 示例替换用
@loadable/component
异步加载,参考各个组件的entry.tsx
文件。(tea-component 目前还不支持 SSR 渲染,docz 示例需要用到 SSR 渲染) - 图片目录
src/assets/
目录下
新增图标
- SVG 文件放在
src/assets/icon
目录下; - 执行:
npm run build:svg
; - 在
src/components/Icon/Icon.tsx
新增图标文件;
本地联调
- 执行
npm run build
或者npm run watch
; - 执行
npm link
; - 在使用组件的工程里,执行
npm link @tencent/climb-ui-component
;
发布组件文档到站点
- 创建开发分支,例如:
feature/menu
; - 开发完,提交 MR 合入到
master
分支, https://git.code.oa.com/tencent_retail/sr-ui-component/merge_requests/new - 几分钟后自动部署到 http://sr-component.pages.oa.com/
发布组件到 http://tnpm.oa.com/
注意:如果 ESLint
不工作,请尝试:
- 删除
node_modules
目录 - 卸载全局的
eslint
和prettier
:npm uninstall eslint prettier -g
- 单独使用
npm i
安装一次
参考: