Installation
Requirements
| Requirement | Version |
|---|---|
| Flutter | ≥ 3.12.2 |
| Dart SDK | ≥ 3.12.2 |
Add the dependency
Run in your project root:
bash
flutter pub add flutter_miuixOr add it to pubspec.yaml manually:
yaml
dependencies:
flutter_miuix: ^1.0.1Then run:
bash
flutter pub getImport
A single import exposes the entire public API:
dart
import 'package:flutter_miuix/miuix.dart';Transitive dependencies
Installing flutter_miuix automatically pulls in the following — no manual setup required:
| Dependency | Purpose |
|---|---|
material_color_utilities | HCT color science + Material dynamic color schemes (TonalSpot / Vibrant and 7 more), used to generate a full miuix color scheme from a seed color |
dynamic_color | Android wallpaper color extraction (the Android implementation of miuixPlatformDynamicColors); other platforms automatically fall back to a fixed seed |
The fragment shader used by the liquid-glass effects (shaders/miuix_bloom_stroke.frag) ships with the package — no extra configuration needed either.
Platform notes
All platforms (Android / iOS / macOS / Windows / Linux / Web) are fully supported with no platform-side setup. The only difference is that wallpaper dynamic color works on Android only; other platforms fall back to a fixed seed color (see Theming).
Next steps
- Quick Start — build your first Miuix page