https://github.com/pengyyyyy/tdesign-custom
a custom ui libary base on tdesign
https://github.com/pengyyyyy/tdesign-custom
tdesign
Last synced: 3 months ago
JSON representation
a custom ui libary base on tdesign
- Host: GitHub
- URL: https://github.com/pengyyyyy/tdesign-custom
- Owner: PengYYYYY
- Created: 2022-11-19T16:20:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-19T03:09:12.000Z (almost 2 years ago)
- Last Synced: 2025-01-08T15:00:39.857Z (5 months ago)
- Topics: tdesign
- Language: JavaScript
- Homepage: https://pengyyyyy.github.io/tdesign-custom
- Size: 11.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
### 安装
#### 使用 npm 安装
推荐使用 npm 方式进行开发
```shell
npm i tdesign-custom
```
### 使用
#### 基础使用
```js
import Vue from 'vue';
import TdesignCustom from 'tdesign-custom';
Vue.use(TdesignCustom);
```
### scripts
- `init`: 子仓库依赖初始化
- `dev:site`: 示例文档站点开发环境
- `build:site`: 示例站点打包
- `build:pkg`: `npm` 包构建
- `build:tsc`: `types` 文件构建
- `test:update`: 单元测试更新
### 如何开发业务组件
> 组件目录如下
```text
custom
├── __tests__ // 单元测试目录
│ └── index.test.jsx
├── _example // 示例文档目录
│ └── base.vue
├── api_en.md // 英文API文档
├── custom.en-US.md // 英文示例文档
├── custom.md // 示例文档
├── custom.tsx // 组件
├── index.ts // 组件入口
├── type.ts // ts 类型文件
├── props.ts // props 文件
└── style // 样式目录
├── _index.less // 样式文件
├── css.js // 样式中介文件
└── index.js // 样式中介文件
```
> 开发规范
- 业务组件前缀统一为 `TCus`
### 单元测试
遵循[TD单元测试规范](https://github.com/Tencent/tdesign-vue-next/wiki/TDesign-%E5%8D%95%E5%85%83%E6%B5%8B%E8%AF%95%E8%A7%84%E8%8C%83)