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/style/index.css'
import 'tdesign-web-components/lib/button'

import 'tdesign-web-components/lib/jsx';

render(jsx`<t-button>Hello TDesign</t-button>`, document.body);

More ways to use please click 👉🏻 getting-started

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

| 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.

Contributors

Feedback

Create your Github issues or scan the QR code below to join our user groups

License

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