tdesign-flutter

<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://github.com/Tencent/tdesign-flutter/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/tencent/tdesign-flutter" alt="License">
  </a>
  <a href="https://pub.dev/packages/tdesign_flutter">
    <img src="https://img.shields.io/pub/v/tdesign_flutter" alt="Version">
  </a>
  <a href="https://pub.dev/packages/tdesign_flutter/score">
    <img src="https://img.shields.io/pub/dm/tdesign_flutter" alt="Downloads">
  </a>
  <a href="https://deepwiki.com/Tencent/tdesign-flutter">
    <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
  </a>
</p>

English | [简体中文](./README_zh_CN.md)

**TDesign Flutter** is a cross-platform UI component library based on Tencent's design system. Built with the Flutter framework, it enables rapid development of beautiful, consistent mobile/web applications with rich pre-built components and theme customization capabilities, supporting iOS, Android, and Web platforms.

## 🎉 Features

- Provides Flutter UI component library following TDesign design specifications
- Supports theme customization to match your App's design style
- Includes a comprehensive Icon library with custom replacement support
- Defines color groups according to TDesign specifications (viewable in `TColors`)
- Real-time preview of default color values through the color declaration class

## 📱 Preview

**Android**: Scan the QR code to download the preview app

<img width="200" src="https://raw.githubusercontent.com/Tencent/tdesign-flutter/develop/tdesign-site/site/public/assets/qrcode/t_apk_qrcode.png" />

Download link: [tdesign-flutter-example.apk](https://tdesign.gtimg.com/flutter/tdesign_flutter_example.apk)

**iOS**: Run the project to preview

[https://github.com/Tencent/tdesign-flutter/tree/main/tdesign-component](https://github.com/Tencent/tdesign-flutter/tree/main/tdesign-component)

## 🚀 Quick Start

Upgrading from 0.2.7? Read the [1.0 migration guide (Chinese)](./tdesign-site/site/docs/migration-0.2.7-to-1.0.md) before changing the dependency. Version 1.0 contains breaking API and behavior changes.

Requires Flutter ≥ 3.32.0 and Dart ≥ 3.8.0.

Add `tdesign_flutter: ^1.1.0` to `pubspec.yaml` and run `flutter pub get`. See [Getting started](./tdesign-site/site/docs/getting-started.md) for the complete setup.

### Minimal Import

```dart
import 'package:tdesign_flutter/tdesign_flutter.dart';
```

The TDesign entry point re-exports Flutter Material widgets, so the same import provides `MaterialApp`, `Scaffold`, `Text`, and TDesign components.

### Minimal Usage

Add the button to the widget tree of an existing page:

```dart
const TButton(child: Text('Button'))
```

No additional initialization or theme configuration is required. Omitting `onPressed` leaves the button disabled.

## 📚 Documentation

The detail