tdesign-react
Version:
TDesign Component for React
103 lines (71 loc) • 5.81 kB
Markdown
<p align="center">
<a href="https://tdesign.tencent.com/" target="_blank">
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/site/TDesign.png" />
</a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/tdesign-react">
<img src="https://img.shields.io/npm/l/tdesign-react.svg?sanitize=true" alt="License" />
</a>
<a href="https://app.codecov.io/gh/Tencent/tdesign-react">
<img src="https://img.shields.io/codecov/c/github/Tencent/tdesign-react/develop.svg?style=flat-square" alt="codecov">
</a>
<a href="https://www.npmjs.com/package/tdesign-react">
<img src="https://img.shields.io/npm/v/tdesign-react.svg?sanitize=true" alt="Version">
</a>
<a href="https://www.npmjs.com/package/tdesign-react">
<img src="https://img.shields.io/npm/dm/tdesign-react.svg?sanitize=true" alt="Downloads" />
</a>
</p>
English | [简体中文](./README-zh_CN.md)
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
```shell
npm i tdesign-react
```
```shell
yarn add tdesign-react
```
```shell
pnpm add tdesign-react
```
# 🔨 Usage
```tsx
import React from 'react';
import { Button } from 'tdesign-react';
import 'tdesign-react/es/style/index.css';
function App() {
return <Button>Hello TDesign</Button>;
}
ReactDOM.createRoot(document.getElementById('app')).render(<App />);
```
The package of tdesign-react provides kinds of bundles, read [the documentation](https://github.com/Tencent/tdesign/blob/main/docs/develop-install.md) for the detail of differences between bundles.
# Quick Start
Visit [TDesign Starter](https://tdesign.tencent.com/starter/react/) to experience in the application built with TDesign React UI components.
# Browser Support
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
Read our [browser compatibility](https://github.com/Tencent/tdesign/wiki/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](https://github.com/Tencent/tdesign-vue-next)
- component library for Vue 2.x : [tdesign-vue](https://github.com/Tencent/tdesign-vue)
- component library for Wechat miniprogram : [tdesign-miniprogram](https://github.com/Tencent/tdesign-miniprogram)
# Contributing
Contributing is welcome. Read [guidelines for contributing](https://github.com/Tencent/tdesign-react/blob/develop/CONTRIBUTING.md) before submitting your [Pull Request](https://github.com/Tencent/tdesign-react/pulls).
## Contributors
<a href="https://github.com/tencent/tdesign-react/graphs/contributors">
<img src="https://contrib.rocks/image?repo=tencent/tdesign-react" />
</a>
# Feedback
Create your [Github issues](https://github.com/Tencent/tdesign-react/issues) or scan the QR code below to join our user groups
<img src="https://raw.githubusercontent.com/Tencent/tdesign/main/packages/components/src/images/groups/react-group.png" width="200" />
# License
The MIT License. Please see [the license file](./LICENSE) for more information.