fluxui_kit

A token-driven Flutter UI system — 30+ components, zero hardcoded values.

Every color, spacing value, typography style, and animation duration resolves through strongly typed design tokens. Light and dark built in. Fully customisable.

Part of the FluxUI monorepo.

---

Installation

dependencies:
  fluxui_kit: ^0.1.0

---

Quick start

import 'package:fluxui_kit/fluxui_kit.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: AppTheme.light(),
      darkTheme: AppTheme.dark(),
      home: Scaffold(
        body: Padding(
          padding: EdgeInsets.all(24),
          child: Column(
            children: [
              AppButton(text: 'Primary', onPressed: () {}),
              AppButton.secondary(text: 'Secondary', onPressed: () {}),
              AppTextField(labelText: 'Email', hintText: 'you@example.com'),
            ],
          ),
        ),
      ),
    );
  }
}

---

Theme API

Method	Description
AppTheme.light()	Material 3 light theme using AppDesignTokens.light
AppTheme.dark()	Material 3 dark theme using AppDesignTokens.dark
AppTheme.custom(tokens, brightness)	Fully custom theme from any AppDesignTokens

All methods accept optional fontFamily and useMaterial3 parameters.

Custom branding

final myTheme = AppTheme.custom(
  tokens: AppDesignTokens.light.copyWith(
    colors: AppColorTokens.light.copyWith(primary: Color(0xFF6366F1)),
  ),
  brightness: Brightness.light,
);

Optional theme override with FluxThemeData

Override only the tokens you need via the standard Flutter ThemeExtension mechanism. All fields are optional — unset fields fall back to existing tokens:

MaterialApp(
  theme: AppTheme.light().copyWith(
    extensions: <ThemeExtension<dynamic>>[
      ...AppTheme.light().extensions.values,
      FluxThemeData(
        colors: AppColorTokens.light.copyWith(
          primary: Color(0xFF6366F1),
        ),
      ),
    ],
  ),
);

If no FluxThemeData is provided, the system behaves identically to the default setup.

---

Accessing tokens in widgets

// Inside any build method:
final colors     = context.appColors;
final spacing    = context.appSpacing;
final radius     = context.appRadius;
final sizes      = context.appSizes;
final motion     = context.appMotion;
final typography = context.appTypography;

// Check for optional FluxThemeData overrides:
final flux = context.fluxTheme; // FluxThemeData?

---

Components (30+)

Category	Widgets
Buttons	AppButton — primary · secondary · outline · ghost; sm/md/lg; loading state
Cards	AppCard — surface · outlined · muted
Display	AppAvatar · AppBadge · AppCarousel
Feedback	AppAlert · AppBottomSheet · AppDialog · AppProgress · AppSkeleton · AppToast
Inputs	AppCombobox · AppOtpField · AppSearchBar · AppSlider · AppTextField
Layouts	Gap · HStack · VStack
Navigation	AppAppBar · AppBottomNav · AppNavigationMenu · AppPagination · AppTabs
Roadmap	AppRoadmapItem
Selection	AppCheckbox · AppChip · AppRadio · AppSwitch
Typography	AppText — 15 type-scale variants, 7 semantic tones

---

Design tokens

fluxui_kit re-exports flutter_ui_tokens which provides:

Class	Covers
AppColorTokens	Primary, secondary, surface, status, border, overlay, shadow
AppSpacingTokens	Scale none (0 dp) → x5l (64 dp)
AppRadiusTokens	Corner radius scale none → pill
AppSizeTokens	Icon sizes (12–32 dp), control heights (32–60 dp), container widths
AppMotionTokens	Durations: instant · fast · moderate · slow · emphasized
AppTypographyTokens	Full Material 3 text scale (15 styles)
AppDesignTokens	Aggregate — .light and .dark static constants

---

Theme resolution order

When a component reads tokens (e.g. context.appColors), the resolution is:

1. FluxThemeData (if present in the theme) — partial overrides take priority
2. AppThemeTokens (injected by AppTheme.light()/.dark()/.custom())
3. Brightness-based defaults (AppDesignTokens.light or .dark)

This means existing apps work without changes. Providing FluxThemeData is entirely optional.

---

Requirements

• Dart SDK >=3.4.0 <4.0.0
• Flutter >=3.24.0

---

Repository

github.com/abdelrzz9/FluxUI — monorepo containing flutter_ui_tokens, flutter_ui_utils, fluxui_kit, flutter_ui, and the flux CLI.

License

MIT — see LICENSE.