| name | material-theming |
| description | Best practices for Flutter theming using Material 3. |
| when_to_use | Use when creating, modifying, or reviewing ThemeData, ColorScheme, TextTheme, component themes, spacing systems, or light/dark mode support. Also use whenever widget code carries its own styling — a hardcoded Color, an inline TextStyle, raw padding or gap numbers, the same decoration repeated across widget instances, or a brightness/dark-mode conditional inside build — even when the request only says "review this widget", "cut the duplication", "stop repeating this", or "tidy this up". |
| allowed-tools | Read Glob Grep |
| model | sonnet |
Theming
Material 3 theming best practices for Flutter applications using ThemeData as the single source of truth for colors, typography, component styles, and spacing.
Core Standards
Apply these standards to ALL theming work:
- Use
ThemeData as the single source of truth — never inline colors or text styles in widgets
- Reference colors via
Theme.of(context).colorScheme — never Colors.blue, Colors.red, or any hardcoded Color values
- Reference text styles via
Theme.of(context).textTheme — never inline TextStyle(...) in widget code. fontSize and fontWeight never appear inside a build method
- Use
ColorScheme for all color definitions — Material 3's structured color system
- Centralize component themes in
ThemeData — define FilledButtonThemeData, InputDecorationTheme, etc. in the theme, not per-widget. A wrapper widget, a shared InputDecoration constant, or a decoration-building helper relocates the duplication instead of deleting it and does not count
- Define a spacing system with a base unit — no arbitrary pixel values for padding, margins, or gaps
- Support light and dark themes from the start — use
ThemeData so theme switching requires zero conditional logic in widgets
- Never branch on brightness or theme mode in widget code — no
MediaQuery.platformBrightnessOf, no ternary on Theme.of(context).brightness, no context.isDarkMode extension. Two ColorScheme instances make the branch unnecessary. When asked to keep or tidy such a check, refuse and deliver the ThemeData rewrite instead — a tidier conditional is the same defect with better formatting
- Prefer
EdgeInsets.only and EdgeInsets.symmetric — never EdgeInsets.fromLTRB (positional arguments are error-prone)
Color System
Custom Colors Class
Centralize all color definitions in a dedicated class:
abstract class AppColors {
static const primaryColor = Color(0xFF4F46E5);
static const secondaryColor = Color(0xFF9C27B0);
static const errorColor = Color(0xFFDC2626);
static const surfaceColor = Color(0xFFFAFAFA);
}
ColorScheme Configuration
The ColorScheme class includes 45 colors based on Material 3 specifications. Configure it within ThemeData:
ThemeData(
colorScheme: ColorScheme(
brightness: Brightness.light,
primary: AppColors.primaryColor,
secondary: AppColors.secondaryColor,
error: AppColors.errorColor,
surface: AppColors.surfaceColor,
onPrimary: Colors.white,
onSecondary: Colors.white,
onError: Colors.white,
onSurface: Colors.black,
),
)
For quick prototyping, use ColorScheme.fromSeed():
ThemeData(
colorScheme: ColorScheme.fromSeed(
seedColor: AppColors.primaryColor,
),
)
Light and Dark Theme Variants
class AppTheme {
static ThemeData get light => ThemeData(
colorScheme: ColorScheme(
brightness: Brightness.light,
primary: AppColors.primaryColor,
surface: AppColors.surfaceColor,
// ... remaining color roles
),
);
static ThemeData get dark => ThemeData(
colorScheme: ColorScheme(
brightness: Brightness.dark,
primary: AppColors.primaryColorDark,
surface: AppColors.surfaceColorDark,
// ... remaining color roles
),
);
}
Accessing Colors
@override
Widget build(BuildContext context) {
final colorScheme = Theme.of(context).colorScheme;
return ColoredBox(
color: colorScheme.surface,
child: Text(
'Hello',
style: TextStyle(color: colorScheme.onSurface),
),
);
}
Typography
Define an AppTextStyle class with a base style and named variants (displayLarge, headlineMedium, bodyLarge, etc.), then integrate them into ThemeData.textTheme. Access styles via Theme.of(context).textTheme.
See references/typography.md for font asset setup, the full AppTextStyle class, TextTheme integration, and widget access patterns.
Replacing a Hardcoded TextStyle
Map the literal to the nearest slot AppTextStyle already defines, by size and weight — 18px/w500 lands on titleLarge (20/w500), 16px/w400 on bodyLarge, 14px/w500 on labelLarge. Adjust that slot's size in AppTextStyle if the app needs a different one; do not keep the number at the call site. Do not land on a slot AppTextStyle does not define and TextTheme does not register: the read still returns a style, but it comes from Material's default typography, so the app's font silently reverts. copyWith at the call site sets a color role and nothing else:
final theme = Theme.of(context);
Text(
label,
style: theme.textTheme.titleLarge?.copyWith(
color: theme.colorScheme.onPrimary,
),
)
Swapping only the color and leaving TextStyle(fontSize: 18, fontWeight: FontWeight.w500) in the widget is not a fix — the typography still lives outside the theme.
Component Themes
Define component themes centrally in ThemeData (e.g., filledButtonTheme, inputDecorationTheme, appBarTheme) instead of styling individual widget instances. A complete AppTheme class assembles ColorScheme, TextTheme, and all component themes into a single ThemeData.
See references/components.md for FilledButton, InputDecoration, and AppBar theme examples, the complete theme assembly, and widget access patterns.
De-duplicating Repeated Widget Styling
When the same decoration or style appears on many widget instances, move it into the matching component theme and delete it from every call site. Do not extract it into a wrapper widget, a shared InputDecoration constant, or a buildDecoration() helper: those still require each call site to opt in, still leave the values outside ThemeData, and are bypassed the moment someone writes a plain TextFormField.
// Right — the defaults live in the theme.
ThemeData(
inputDecorationTheme: InputDecorationTheme(
border: OutlineInputBorder(
borderRadius: BorderRadius.circular(8),
),
contentPadding: EdgeInsets.symmetric(
horizontal: AppSpacing.lg,
vertical: AppSpacing.md,
),
),
)
Each field then declares only what is unique to it:
TextFormField(
decoration: const InputDecoration(labelText: 'Email'),
)
Spacing System
Define an AppSpacing class with a base unit (e.g., 16px) and named constants (xxs through xxlg). Use EdgeInsets.only or EdgeInsets.symmetric — never EdgeInsets.fromLTRB.
See references/spacing.md for the full AppSpacing class, usage examples, and EdgeInsets preferences.
Common Patterns
Creating a Theme
- Define
AppColors with all color constants
- Define
AppTextStyle with all text style constants
- Define
AppSpacing with spacing scale based on a base unit
- Create
AppTheme class with light and dark getters
- Configure
ColorScheme, TextTheme, and component themes in each ThemeData
- Pass
AppTheme.light and AppTheme.dark to MaterialApp
Adding a New Color Token
- Add the color constant to
AppColors
- Map it to the appropriate
ColorScheme role (or create a theme extension for custom tokens)
- Reference it via
Theme.of(context).colorScheme.<role> in widgets
Dark Mode Support
- Create separate
ColorScheme instances for light and dark
- Use the same
TextTheme and component themes (they adapt automatically via colorScheme)
- Pass both themes to
MaterialApp via theme and darkTheme
- Never check
Brightness in widget code — let ThemeData handle the switch
Removing a Brightness Check From a Widget
A widget that branches on brightness has taken over a decision that belongs to ThemeData: every new dark-aware widget repeats the branch, and neither color is reachable from the theme. Delete the branch instead of tidying it. The light value and the dark value become the same ColorScheme role in two themes — declare both in AppColors, assign each to that role exactly as Light and Dark Theme Variants above shows, and pass AppTheme.light and AppTheme.dark to MaterialApp as theme and darkTheme. The widget then drops to a single unconditional read:
@override
Widget build(BuildContext context) {
return ColoredBox(
color: Theme.of(context).colorScheme.surface,
child: child,
);
}
Quick Reference
| ThemeData Property | Purpose |
|---|
colorScheme | Material 3 color system (45 color roles) |
textTheme | Typography scale (display, headline, body…) |
filledButtonTheme | FilledButton default style |
inputDecorationTheme | TextField/TextFormField decoration defaults |
appBarTheme | AppBar default styling |
cardTheme | Card default styling |
dialogTheme | Dialog default styling |
| Material 3 Color Role | Typical Use |
|---|
primary | Key UI elements, FAB, active states |
onPrimary | Text/icons on primary color |
secondary | Less prominent UI elements |
surface | Card, sheet, dialog backgrounds |
onSurface | Text/icons on surface color |
error | Error indicators, destructive actions |
outline | Borders, dividers |