README.md

English | 简体中文

TDesign React is a UI component library for React 16.x and desktop application.

🎉 Features

• Desktop application interaction
• High quality UI components for React
• Consistent API and UI with TDesign component libraries for other frameworks
• Dark mode and customizable theme
• Support tree-shaking

📦 Installation

npm i tdesign-react

🔨 Usage

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'));

The package of tdesign-react provides kinds of bundles, read the documentation for the detail of differences between bundles.

Quick Start

Visit TDesign Starter to experience in the application built with TDesign React UI components.

Browser Support

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

Read our browser compatibility for more details.

TDesign component libraries

TDesign also provides component libraries for other platforms and frameworks.

• component library for Vue 3.x : tdesign-vue-next
• component library for Vue 2.x : tdesign-vue
• component library for Wechat miniprogram : tdesign-miniprogram

Contributing

Contributing is welcome. Read guidelines for contributing before submitting your Pull Request.

License

The MIT License. Please see the license file for more information.