Skip to content
On this page

Quick Start

Install the current FluttyUI source and create your first Flutter application.

Requirements

The current FluttyUI source requires Flutter 3.44 or later and Dart 3.12 or later. The example catalog and optional map adapters can require a newer SDK; check their own pubspec.yaml files.

Add the package

These docs follow the 0.0.2 source checkout. Connect an existing checkout with a path dependency in your application's pubspec.yaml:

dependencies:
  flutter:
    sdk: flutter
  fluttyui:
    path: ../fluttyui

Adjust the path to point to your FluttyUI package directory, then resolve dependencies:

flutter pub get

The published package on pub.dev is available with flutter pub add fluttyui. The latest published version verified for these docs is 0.0.1; its API may differ from the source documented here.

Create an application

Import Flutter's widgets and FluttyUI's public entry point. The ui prefix keeps toolkit names clear when Flutter exports a similarly named widget.

import 'package:flutter/widgets.dart';
import 'package:fluttyui/fluttyui.dart' as ui;

void main() => runApp(
  ui.FluttyApp(
    home: Center(
      child: ui.Button(
        text: 'Hello, FluttyUI',
        onPressed: () {},
      ),
    ),
  ),
);

Configure your theme

final theme = ui.ThemeData(
  colors: ui.ColorTokens(brand: ui.Colors.violet.shade600),
);

ui.FluttyApp(
  theme: theme,
  home: const Center(child: Text('Hello')),
);

Read theming for light and dark themes, shared sizes, spacing, and fonts.

Run the component catalog

From the core package checkout:

flutter pub get
cd example
flutter pub get
flutter run

The example opens a searchable catalog with a dedicated interactive demonstration for each component. Its entry point is example/lib/main.dart.

DartFlutter

Get started with FluttyUI