FlexColorScheme

https://docs.flexcolorscheme.com/
Admin
FlexColorScheme is an advanced Flutter package that simplifies creating beautiful Material Design...
Tokens:110,583
Snippets:794
Trust Score:6.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### FlexColorScheme Setup Example

Source: https://docs.flexcolorscheme.com/theming_roads

Illustrates a custom tabBarTheme setup used in conjunction with FlexColorScheme. This snippet shows how to integrate custom themes within the FlexColorScheme framework.

```dart
tabBarTheme: myTabBarTheme,
),
```

--------------------------------

### FlexColorScheme with KeyColors and Tones Example

Source: https://docs.flexcolorscheme.com/api_guide

Demonstrates how to apply FlexColorScheme with predefined key colors and a custom tone setup like FlexTones.vivid. This configuration is used for both light and dark themes, adjusting properties like blendLevel and appBarOpacity for each.

```dart
theme: FlexThemeData.light(
  scheme: FlexScheme.flutterDash,
  usedColors: 4,
  surfaceMode: FlexSurfaceMode.highScaffoldLowSurface,
  blendLevel: 20,
  appBarStyle: FlexAppBarStyle.background,
  appBarOpacity: 0.95,
  tabBarStyle: FlexTabBarStyle.forBackground,
  swapColors: true,
  keyColors: const FlexKeyColors(
    useSecondary: true,
    useTertiary: true,
  ),
  tones: FlexTones.vivid(Brightness.light),
),
darkTheme: FlexThemeData.dark(
  scheme: FlexScheme.flutterDash,
  usedColors: 4,
  surfaceMode: FlexSurfaceMode.highScaffoldLowSurface,
  blendLevel: 15,
  appBarStyle: FlexAppBarStyle.background,
  appBarOpacity: 0.90,
  tabBarStyle: FlexTabBarStyle.forBackground,
  keyColors: const FlexKeyColors(
    useSecondary: true,
    useTertiary: true,
  ),
  tones: FlexTones.vivid(Brightness.dark),
),

```

--------------------------------

### Running the Default Example App

Source: https://docs.flexcolorscheme.com/examples

Instructions to clone the FlexColorScheme repository and run the default example application to experiment with theming options using hot reload.

```bash
cd example/
flutter run
```

--------------------------------

### Simplified FlexKeyColors Configuration

Source: https://docs.flexcolorscheme.com/tutorial4

An example of a simplified `FlexKeyColors` setup where only the primary color is intended to be kept as a given brand color, while secondary and tertiary colors are enabled but not necessarily kept. This demonstrates a common use case for seeded color schemes.

```dart
keyColors: FlexKeyColors(
    useSecondary: true,
    useTertiary: true,
    keepPrimary: true,
  ),
```

--------------------------------

### FlexColorScheme.light() Example with Common Properties

Source: https://docs.flexcolorscheme.com/api_guide

Demonstrates the usage of several FlexColorScheme properties within a `FlexThemeData.light()` call. This includes setting the color scheme, used colors, surface mode, and blend level.

```dart
theme: FlexThemeData.light(
  scheme: FlexScheme.flutterDash,
  usedColors: 4,
  surfaceMode: FlexSurfaceMode.highScaffoldLowSurface,
  blendLevel: 20,

```

--------------------------------

### FlexColorScheme Case 10: FTD.light(scheme) Example

Source: https://docs.flexcolorscheme.com/theming_roads

Demonstrates the usage of FlexColorScheme's FTD.light constructor with a provided ColorScheme. This method is compared to custom ThemeData setups and is highlighted for its ability to generate ThemeData colors equivalent to a given ColorScheme.

```dart
// Example usage (conceptual):
ThemeData themeData = FlexThemeData.light(scheme: ColorScheme.light());
```

--------------------------------

### Initialize Theme Service and Controller (Dart)

Source: https://docs.flexcolorscheme.com/tutorial2

Sets up the application's theme management by initializing a memory-only theme service and a theme controller. It loads initial theme settings before the main UI is built to prevent theme flickers.

```dart
Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // The used memory only theme service.
  final ThemeService themeService = ThemeServiceMem();
  // Initialize the theme service.
  await themeService.init();
  // Create a ThemeController that uses the ThemeService.
  final ThemeController themeController = ThemeController(themeService);
  // Load preferred theme settings, while the app is loading, before MaterialApp
  // is created, this prevents a theme change when the app is first displayed.
  await themeController.loadAll();
  // Run the app and pass in the ThemeController. The app listens to the
  // ThemeController for changes.
  runApp(DemoApp(themeController: themeController));
}

```

--------------------------------

### Initialize ThemeServiceHive and ThemeController

Source: https://docs.flexcolorscheme.com/tutorial4

This code snippet initializes the ThemeServiceHive for persistent local storage using a specified box name. It then creates a ThemeController, loads the theme settings, and runs the demo application, ensuring the theme is applied before the first render.

```dart
// The ThemeServiceHive constructor requires a box name, the others do not.
// The box name is just a file name for the file that stores the settings.
final ThemeService themeService = ThemeServiceHive('flex_color_scheme_v5_box_4');
// Initialize the theme service.
await themeService.init();
// Create a ThemeController that uses the ThemeService.
final ThemeController themeController = ThemeController(themeService);
// Load preferred theme settings, while the app is loading, before MaterialApp
// is created, this prevents a theme change when the app is first displayed.
await themeController.loadAll();
// Run the app and pass in the ThemeController. The app listens to the
// ThemeController for changes.
runApp(DemoApp(themeController: themeController));

```

--------------------------------

### Initialize and Run App with ThemeServicePrefs

Source: https://docs.flexcolorscheme.com/tutorial3

This code snippet shows the main function for a Flutter application that utilizes FlexColorScheme. It initializes the application, sets up ThemeServicePrefs for persistent theme storage, creates a ThemeController, loads theme settings, and then runs the main application widget, passing the controller to it. This ensures theme preferences are loaded before the app UI is displayed.

```dart
Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // Here we use the Shared Preferences theme service.
  final ThemeService themeService = ThemeServicePrefs();
  // Initialize the theme service.
  await themeService.init();
  // Create a ThemeController that uses the ThemeService.
  final ThemeController themeController = ThemeController(themeService);
  // Load preferred theme settings, while the app is loading, before MaterialApp
  // is created, this prevents a theme change when the app is first displayed.
  await themeController.loadAll();
  // Run the app and pass in the ThemeController. The app listens to the
  // ThemeController for changes.
  runApp(DemoApp(themeController: themeController));
}
```

--------------------------------

### Custom FlexTones.vivid Tone Definition

Source: https://docs.flexcolorscheme.com/api_guide

Provides the source code for the predefined FlexTones.vivid constructor. This example shows how to define specific primary and secondary tone levels, chroma values, and minimum chroma constraints for both light and dark brightness.

```dart
static FlexTones vivid(Brightness brightness) =>
    brightness == Brightness.light
        ? const FlexTones.light(
            primaryTone: 30,
            primaryChroma: null,
            secondaryChroma: null,
            tertiaryChroma: null,
            primaryMinChroma: 50,
          )
        : const FlexTones.dark(
            onPrimaryTone: 10,
            primaryContainerTone: 20,
            onErrorContainerTone: 90,
            primaryChroma: null,
            secondaryChroma: null,
            tertiaryChroma: null,
            primaryMinChroma: 50,
          );

```

--------------------------------

### Dynamic Key Colors Configuration with ThemeController

Source: https://docs.flexcolorscheme.com/tutorial3

Demonstrates a dynamic setup for `FlexKeyColors` where the usage of key colors (primary, secondary, tertiary) is controlled by boolean values from a `ThemeController`. This allows for runtime adjustments to theme generation based on user preferences or application state. The `useKeyColors` property acts as a master switch to enable or disable the entire `FlexKeyColors` configuration.

```dart
:
keyColors: FlexKeyColors(
  useKeyColors: themeController.useKeyColors,
  useSecondary: themeController.useSecondary,
  useTertiary: themeController.useTertiary,
),
```

--------------------------------

### Flutter App Theme Setup with FlexColorScheme

Source: https://docs.flexcolorscheme.com/tutorial2

Configures the main MaterialApp widget with custom light and dark themes using FlexThemeData. It supports Material 3, togglable sub-themes, and custom fonts. The theme dynamically updates based on a ThemeController.

```dart
class DemoApp extends StatelessWidget {
  const DemoApp({Key? key, required this.themeController}) : super(key: key);
  final ThemeController themeController;

  @override
  Widget build(BuildContext context) {
    // Whenever the theme controller notifies the listener in the
    // ListenableBuilder, the MaterialApp is rebuilt.
    return ListenableBuilder(
        listenable: themeController,
        builder: (BuildContext context, Widget? child) {
          return MaterialApp(
            debugShowCheckedModeBanner: false,
            scrollBehavior: const AppScrollBehavior(),
            title: 'Custom Theme',
            theme: FlexThemeData.light(
              useMaterial3: themeController.useMaterial3,
              colors: _myFlexScheme.light,
              // Opt in/out on using FlexColorScheme sub-themes.
              subThemesData: themeController.useSubThemes
                  ? const FlexSubThemesData()
                  : null,
              appBarElevation: 0.5,
              visualDensity: VisualDensity.standard,
              fontFamily: GoogleFonts.notoSans().fontFamily,
              // We use the nicer Material-3 Typography in both M2 and M3 mode.
              typography: Typography.material2021(platform: defaultTargetPlatform),
            ),
            // Same setup for the dark theme, but using FlexThemeData.dark().
            darkTheme: FlexThemeData.dark(
              useMaterial3: themeController.useMaterial3,
              colors: _myFlexScheme.dark,
              subThemesData: themeController.useSubThemes
                  ? const FlexSubThemesData()
                  : null,
              appBarElevation: 1,
              visualDensity: VisualDensity.standard,
              fontFamily: GoogleFonts.notoSans().fontFamily,
              typography: Typography.material2021(platform: defaultTargetPlatform),
            ),
            themeMode: themeController.themeMode,
            home: HomePage(
              flexSchemeData: _myFlexScheme,
              // Pass in the theme controller to the home page.
              controller: themeController,
            ),
          );
        });
  }
}

```

--------------------------------

### Set Platform Adaptive Visual Density

Source: https://docs.flexcolorscheme.com/tutorial3

Shows how to set a platform adaptive visual density for `ThemeData` using `FlexColorScheme.comfortablePlatformDensity`. This provides a compromise density for desktops, especially touch-enabled ones, offering larger touch targets than `VisualDensity.adaptivePlatformDensity`'s compact setting.

```dart
  // Use FlexColorScheme static helper comfortablePlatformDensity.
  visualDensity: FlexColorScheme.comfortablePlatformDensity,
```

--------------------------------

### FlexColorScheme Simplified Theming

Source: https://docs.flexcolorscheme.com/theming_roads

Highlights FlexColorScheme as a simplified solution for theme setup. It mentions features like adjustable primary color surface blending, versatile seed-generated ColorSchemes, and built-in color schemes that can serve as starting points or complete themes.

```dart
// Conceptual usage of FlexColorScheme for simplified theming
MaterialApp(
  theme: FlexThemeData.light( // or .dark()
    // ... options
  ),
  // ...
);
```

--------------------------------

### Configure Light Mode FlexKeyColors

Source: https://docs.flexcolorscheme.com/tutorial4

Sets up `FlexKeyColors` for light mode, defining whether to use key colors and which of the primary, secondary, and tertiary colors to retain from the input scheme. This is controlled by `themeController` values.

```dart
keyColors: FlexKeyColors(
    useKeyColors: themeController.useKeyColors,
    useSecondary: themeController.useSecondary,
    useTertiary: themeController.useTertiary,
    // Light mode "keep" color toggle values.
    keepPrimary: themeController.keepPrimary,
    keepSecondary: themeController.keepSecondary,
    keepTertiary: themeController.keepTertiary,
  ),
```

--------------------------------

### Create FlexSchemeColor from Primary Color (Dart)

Source: https://docs.flexcolorscheme.com/tutorial4

Generates a FlexSchemeColor scheme starting from a single primary color. The factory constructor `FlexSchemeColor.from` computes the remaining colors. Optionally, primaryContainer, secondary, and secondaryContainer can also be provided. Specifying `brightness` is recommended for Material-3 compliance.

```dart
  // Vivid green colors.
  static final FlexSchemeColor _myScheme2Light = FlexSchemeColor.from(
    primary: const Color(0xFF065808),
    brightness: Brightness.light,
  );
  static final FlexSchemeColor _myScheme2Dark = FlexSchemeColor.from(
    primary: const Color(0xFF629F80),
    brightness: Brightness.dark,


```

--------------------------------

### Flutter MaterialApp Setup with FlexColorScheme

Source: https://docs.flexcolorscheme.com/tutorial3

Sets up a Flutter `MaterialApp` using `FlexThemeData` for both light and dark themes. It dynamically selects color schemes based on a `ThemeController` and applies custom `surfaceMode` and `blendLevel` settings for visual effects. Includes configuration for Material 3, sub-themes, key colors, typography, and scroll behavior.

```dart
class DemoApp extends StatelessWidget {
  const DemoApp({Key? key, required this.themeController}) : super(key: key);
  final ThemeController themeController;

  @override
  Widget build(BuildContext context) {
    // Whenever the theme controller notifies the listenable in the
    // ListenableBuilder, the MaterialApp is rebuilt.
    return ListenableBuilder(
      listenable: themeController,
      builder: (BuildContext context, Widget? child) {
        return MaterialApp(
          debugShowCheckedModeBanner: false,
          scrollBehavior: const AppScrollBehavior(),
          title: 'Four Themes',
          theme: FlexThemeData.light(
            useMaterial3: themeController.useMaterial3,
            colors: themeController.usedScheme == FlexScheme.custom
                ? _myFlexScheme.light
                : FlexColor.schemes[themeController.usedScheme]!.light,
            surfaceMode: FlexSurfaceMode.highSurfaceLowScaffold,
            blendLevel: 10,
            appBarElevation: 0.5,
            subThemesData:
                themeController.useSubThemes ? const FlexSubThemesData() : null,
            keyColors: FlexKeyColors(
              useKeyColors: themeController.useKeyColors,
              useSecondary: themeController.useSecondary,
              useTertiary: themeController.useTertiary,
            ),
            visualDensity: FlexColorScheme.comfortablePlatformDensity,
            fontFamily: GoogleFonts.notoSans().fontFamily,
            // We use the nicer Material-3 Typography in both M2 and M3 mode.
            typography: Typography.material2021(platform: defaultTargetPlatform),
          ),
          // We make an equivalent definition for the dark theme, but using
          // FlexThemeData.dark() and the dark FlexSchemeColors instead.
          darkTheme: FlexThemeData.dark(
            useMaterial3: themeController.useMaterial3,
            colors: themeController.usedScheme == FlexScheme.custom
                ? _myFlexScheme.dark
                : FlexColor.schemes[themeController.usedScheme]!.dark,
            surfaceMode: FlexSurfaceMode.highScaffoldLowSurfaces,
            blendLevel: 12,
            appBarElevation: 1,
            subThemesData:
                themeController.useSubThemes ? const FlexSubThemesData() : null,
            keyColors: FlexKeyColors(
              useKeyColors: themeController.useKeyColors,
              useSecondary: themeController.useSecondary,
              useTertiary: themeController.useTertiary,
            ),
            visualDensity: FlexColorScheme.comfortablePlatformDensity,
            fontFamily: GoogleFonts.notoSans().fontFamily,
            typography: Typography.material2021(platform: defaultTargetPlatform),
          ),
          // Use the dark or light theme, based on controller setting.
          themeMode: themeController.themeMode,
          // This simple example app has only one page.
          home: HomePage(
            flexSchemeData: themeController.usedScheme == FlexScheme.custom
                ? _myFlexScheme
                : FlexColor.schemes[themeController.usedScheme]!,
            // Pass in the theme controller to the home page where
            // user can change its values with UI controls.
            controller: themeController,
          ),
        );
      },
    );
  }
}

```

--------------------------------

### Custom FlexColorScheme Key Colors and Tones Setup

Source: https://docs.flexcolorscheme.com/tutorial4

Configures FlexColorScheme to use secondary and tertiary palettes while retaining the primary color. It specifically uses the FlexTones.vivid constructor for the light theme, ensuring that the generated tonal palettes closely match the chroma of the input key colors.

```dart
keyColors: FlexKeyColors(
    useSecondary: true,
    useTertiary: true,
    keepPrimary: true,
  ),
  // Tones setup for light theme to keep chroma as given in input key colors.
  tones: FlexTones.vivid(Brightness.light),

```
Tokens:
Raw