Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tencent/tdesign-react
A React UI components lib for TDesign.
https://github.com/tencent/tdesign-react
less pc react tdesign typescript
Last synced: about 11 hours ago
JSON representation
A React UI components lib for TDesign.
- Host: GitHub
- URL: https://github.com/tencent/tdesign-react
- Owner: Tencent
- License: mit
- Created: 2021-12-15T21:50:54.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-26T17:07:51.000Z (5 months ago)
- Last Synced: 2024-04-28T07:51:03.135Z (5 months ago)
- Topics: less, pc, react, tdesign, typescript
- Language: TypeScript
- Homepage: https://tdesign.tencent.com/react
- Size: 21.6 MB
- Stars: 781
- Watchers: 17
- Forks: 302
- Open Issues: 118
-
Metadata Files:
- Readme: README-zh_CN.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
简体中文 | [English](./README.md)
TDesign 适配桌面端的组件库，适合在 React 16.x 及以上技术栈的项目中使用。
# 🎉 特性
- 适配桌面端交互
- 基于 React 16.x（全部基于 React Hooks 的 Functional Component）
- 与其他框架/库（Vue / Angular）版本 UI 保持一致
- 支持暗黑模式及其他主题定制
- 支持按需加载
# 📦 安装
```shell
npm i tdesign-react
```
```shell
yarn add tdesign-react
```
```shell
pnpm add tdesign-react
```
# 🔨 基础使用
推荐使用 Webpack 或 Rollup 等支持 tree-shaking 特性的构建工具，无需额外配置即可实现组件按需引入：
```tsx
import React from 'react';
import { Button } from 'tdesign-react';
import 'tdesign-react/es/style/index.css';
function App() {
return Hello TDesign;
}
ReactDOM.createRoot(document.getElementById('app')).render();
```
npm package 中提供了多种构建产物，可以阅读 [这里](https://github.com/Tencent/tdesign/blob/main/docs/develop-install.md) 了解不同目录下产物的差别。
# 快速体验
可以访问官方提供的 [TDesign Starter](https://tdesign.tencent.com/starter/react/) 项目体验使用 TDesign 组件快速搭建业务系统。
# 浏览器兼容性
| [
](http://godban.github.io/browsers-support-badges/)
IE / Edge | [
](http://godban.github.io/browsers-support-badges/)
Firefox | [
](http://godban.github.io/browsers-support-badges/)
Chrome | [
](http://godban.github.io/browsers-support-badges/)
Safari |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
详情参见[桌面端组件库浏览器兼容性说明](https://github.com/Tencent/tdesign/wiki/Browser-Compatibility)
# 其他技术栈实现
- 桌面端 Vue 3 实现：[web-vue-next](https://github.com/Tencent/tdesign-vue-next)
- 桌面端 Vue 实现： [web-vue](https://github.com/Tencent/tdesign-vue)
- 移动端小程序实现： [小程序](https://github.com/Tencent/tdesign-miniprogram)
# 参与贡献
TDesign 欢迎任何愿意参与贡献的参与者。如果需要本地运行代码或参与贡献，请先阅读[参与贡献](https://github.com/Tencent/tdesign-react/blob/develop/CONTRIBUTING.md)。
## 贡献成员
# 反馈
有任何问题，建议通过 [Github issues](https://github.com/Tencent/tdesign-react/issues) 反馈或扫码加入用户微信群。
# 开源协议
TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-react/LICENSE)。