README-zh_CN.md

简体中文 | English

TDesign 适配桌面端的组件库，适合在 React 16.x 及以上技术栈的项目中使用。

🎉 特性

• 适配桌面端交互
• 基于 React 16.x（全部基于 React Hooks 的 Functional Component）
• 与其他框架/库（Vue / Angular）版本 UI 保持一致
• 支持暗黑模式及其他主题定制
• 支持按需加载

📦 安装

npm i tdesign-react

🔨 基础使用

推荐使用 Webpack 或 Rollup 等支持 tree-shaking 特性的构建工具，无需额外配置即可实现组件按需引入：

import { Button } from 'tdesign-react';
import 'tdesign-react/es/style/index.css'; // 少量公共样式

function App() {
  return (
    <Button>
      Hello TDesign
    </Button>
  );
}

ReactDOM.render(<App />, document.getElementById('app'));

npm package 中提供了多种构建产物，可以阅读 这里 了解不同目录下产物的差别。

快速体验

可以访问官方提供的 TDesign Starter 项目体验使用 TDesign 组件快速搭建业务系统。

浏览器兼容性

IE / Edge	Firefox	Chrome	Safari
Edge >=84	Firefox >=83	Chrome >=84	Safari >=14.1

详情参见桌面端组件库浏览器兼容性说明

其他技术栈实现

• 桌面端 Vue 3 实现：web-vue-next
• 桌面端 Vue 实现： web-vue
• 移动端小程序实现： 小程序

参与贡献

TDesign 欢迎任何愿意参与贡献的参与者。如果需要本地运行代码或参与贡献，请先阅读参与贡献。

开源协议

TDesign 遵循 MIT 协议。