Awesome
<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-web-components"> <img src="https://img.shields.io/npm/l/tdesign-web-components.svg?sanitize=true" alt="License" /> </a> <a href="https://app.codecov.io/gh/Tencent/tdesign-web-components"> <img src="https://img.shields.io/codecov/c/github/Tencent/tdesign-web-components/develop.svg?style=flat-square" alt="codecov"> </a> <a href="https://www.npmjs.com/package/tdesign-web-components"> <img src="https://img.shields.io/npm/v/tdesign-web-components.svg?sanitize=true" alt="Version"> </a> <a href="https://www.npmjs.com/package/tdesign-web-components"> <img src="https://img.shields.io/npm/dm/tdesign-web-components.svg?sanitize=true" alt="Downloads" /> </a> </p>English | įŽäŊä¸æ
TDesign Web Components is a UI component and is suitable for use in any front-end project.
đ Features
- Desktop application interaction
- High quality UI components based on omi
- Consistent API and UI with TDesign component libraries for other frameworks
- Dark mode and customizable theme
- Support tree-shaking
đĻ Installation
npm i tdesign-web-components
yarn add tdesign-web-components
pnpm add tdesign-web-components
đ¨ Usage
import 'tdesign-web-components/lib/button'
import 'tdesign-web-components/lib/style/index.css'
document.querySelector('#app').innerHTML = `<t-button>Hello TDesign</t-button>`
The package of tdesign-web-components 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
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.
Contributors
<a href="https://github.com/TDesignOteam/tdesign-web-components/graphs/contributors"> <img src="https://contrib.rocks/image?repo=TDesignOteam/tdesign-web-components" /> </a>Feedback
Create your Github 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 for more information.