Theme Extensions Builder

https://pub.dev/packages/theme_extensions_builder
Admin
Theme Extensions Builder is a code generator for Flutter's ThemeExtension classes that automatically...
Tokens:6,467
Snippets:114
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example pubspec.yaml Dependency

Source: https://pub.dev/packages/theme_extensions_builder/install

This is how the dependency will appear in your pubspec.yaml file after running the add command.

```yaml
dependencies:
  theme_extensions_builder: ^7.3.0
```

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

### Example pubspec.yaml Dependency

Source: https://pub.dev/packages/theme_extensions_builder_annotation/install

This is how the dependency will appear in your pubspec.yaml file after adding the package.

```yaml
dependencies:
  theme_extensions_builder_annotation: ^7.3.0
```

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

### Add theme_extensions_builder to Project

Source: https://pub.dev/packages/theme_extensions_builder

Install the necessary packages for theme_extensions_builder. This includes build_runner for code generation and the theme_extensions_builder and theme_extensions_builder_annotation packages.

```bash
flutter pub add --dev build_runner
flutter pub add --dev theme_extensions_builder
flutter pub add theme_extensions_builder_annotation
```

```yaml
dependencies:
  theme_extensions_builder_annotation: ^7.3.0

dev_dependencies:
  build_runner: ^2.13.0
  theme_extensions_builder: ^7.3.0
```

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

### Setup Dart File for Theme Extension

Source: https://pub.dev/packages/theme_extensions_builder

Create a Dart file with necessary imports and a part directive for the generated code. The part file must follow the pattern `<filename>.g.theme.dart`.

```dart
// lib/theme/app_theme.dart

import 'package:flutter/material.dart';
import 'package:theme_extensions_builder_annotation/theme_extensions_builder_annotation.dart';

part 'app_theme.g.theme.dart';
```

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

### Import theme_extensions_builder in Dart Code

Source: https://pub.dev/packages/theme_extensions_builder/install

Import the library into your Dart files to start using its functionality.

```dart
import 'package:theme_extensions_builder/theme_extensions_builder.dart';
```

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

### Basic ButtonTheme Extension Definition

Source: https://pub.dev/packages/theme_extensions_builder

Example of defining a `ButtonTheme` extension using `@ThemeExtensions()`. This demonstrates the basic structure for creating custom theme extensions.

```dart
@ThemeExtensions()
class ButtonTheme extends ThemeExtension<ButtonTheme> with _$ButtonTheme {
  const ButtonTheme({
    required this.backgroundColor,
    required this.foregroundColor,
    this.borderRadius,
    this.padding,
  });

  final Color backgroundColor;
  final Color foregroundColor;
  final BorderRadius? borderRadius;
  final EdgeInsets? padding;
}
```

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

### Define Multiple Theme Extensions

Source: https://pub.dev/packages/theme_extensions_builder

Define multiple theme extensions within a single Dart file. This example shows how to create `AppColors` and `AppTypography` extensions and then use them in `ThemeData`.

```dart
@ThemeExtensions()
class AppColors extends ThemeExtension<AppColors> with _$AppColors {
  const AppColors({
    required this.primary,
    required this.secondary,
    required this.error,
  });

  final Color primary;
  final Color secondary;
  final Color error;
}

@ThemeExtensions()
class AppTypography extends ThemeExtension<AppTypography> with _$AppTypography {
  const AppTypography({
    required this.heading,
    required this.body,
    required this.caption,
  });

  final TextStyle heading;
  final TextStyle body;
  final TextStyle caption;
}

// Usage in ThemeData
final theme = ThemeData.light().copyWith(
  extensions: [
    AppColors(
      primary: Colors.blue,
      secondary: Colors.green,
      error: Colors.red,
    ),
    AppTypography(
      heading: TextStyle(fontSize: 24, fontWeight: FontWeight.bold),
      body: TextStyle(fontSize: 16),
      caption: TextStyle(fontSize: 12, color: Colors.grey),
    ),
  ],
);

```

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

### Generated AlertThemeData Mixin and Methods

Source: https://pub.dev/packages/theme_extensions_builder

This is an example of the code generated by the ThemeGenGenerator. It includes a mixin with methods for lerp, copyWith, merge, operator ==, and hashCode.

```dart
part of 'alert_theme_data.dart';

// **************************************************************************
// ThemeGenGenerator
// **************************************************************************

mixin _$AlertThemeData {
  bool get canMerge => true;

  static AlertThemeData? lerp(AlertThemeData? a, AlertThemeData? b, double t) {
    if (identical(a, b)) {
      return a;
    }

    if (a == null) {
      return t == 1.0 ? b : null;
    }

    if (b == null) {
      return t == 0.0 ? a : null;
    }

    return AlertThemeData(
      transitionDuration: lerpDuration$(
        a.transitionDuration,
        b.transitionDuration,
        t,
      )!,
      iconPadding: EdgeInsetsGeometry.lerp(a.iconPadding, b.iconPadding, t),
      titleTextStyle: TextStyle.lerp(a.titleTextStyle, b.titleTextStyle, t),
      borderRadius: lerpDouble$(a.borderRadius, b.borderRadius, t),
    );
  }

  AlertThemeData copyWith({
    Duration? transitionDuration,
    EdgeInsetsGeometry? iconPadding,
    TextStyle? titleTextStyle,
    double? borderRadius,
  }) {
    final _this = (this as AlertThemeData);

    return AlertThemeData(
      transitionDuration: transitionDuration ?? _this.transitionDuration,
      iconPadding: iconPadding ?? _this.iconPadding,
      titleTextStyle: titleTextStyle ?? _this.titleTextStyle,
      borderRadius: borderRadius ?? _this.borderRadius,
    );
  }

  AlertThemeData merge(AlertThemeData? other) {
    final _this = (this as AlertThemeData);

    if (other == null || identical(_this, other)) {
      return _this;
    }

    if (!other.canMerge) {
      return other;
    }

    return copyWith(
      transitionDuration: other.transitionDuration,
      iconPadding: other.iconPadding,
      titleTextStyle:
          _this.titleTextStyle?.merge(other.titleTextStyle) ??
          other.titleTextStyle,
      borderRadius: other.borderRadius,
    );
  }

  @override
  bool operator ==(Object other) {
    if (identical(this, other)) {
      return true;
    }

    if (other.runtimeType != runtimeType) {
      return false;
    }

    final _this = (this as AlertThemeData);
    final _other = (other as AlertThemeData);

    return _other.transitionDuration == _this.transitionDuration &&
        _other.iconPadding == _this.iconPadding &&
        _other.titleTextStyle == _this.titleTextStyle &&
        _other.borderRadius == _this.borderRadius;
  }

  @override
  int get hashCode {
    final _this = (this as AlertThemeData);

    return Object.hash(
      runtimeType,
      _this.transitionDuration,
      _this.iconPadding,
      _this.titleTextStyle,
      _this.borderRadius,
    );
  }
}
```

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

### Generate Theme Extension Code

Source: https://pub.dev/packages/theme_extensions_builder

Run the build runner to generate the necessary code for your theme extension. Use 'build' for a one-time generation or 'watch' to automatically rebuild on file changes.

```bash
# One-time generation
dart run build_runner build

# Watch mode (rebuilds on file changes)
dart run build_runner watch
```

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

### Build Configuration for Theme Extensions Builder

Source: https://pub.dev/packages/theme_extensions_builder

Optional `build.yaml` configuration to enable the `theme_extensions_builder` for code generation. This allows customization of build processes.

```yaml
targets:
  $default:
    builders:
      theme_extensions_builder:
        enabled: true
        options:
          # Add custom options here if needed


```

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

### VS Code IDE Configuration for File Nesting

Source: https://pub.dev/packages/theme_extensions_builder

Configure VS Code's `settings.json` to automatically nest generated `.g.theme.dart` files alongside their corresponding `.dart` files. This improves project organization.

```json
{
  "explorer.fileNesting.enabled": true,
  "explorer.fileNesting.patterns": {
    "*.dart": "${capture}.g.theme.dart"
  }
}

```

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

### Add theme_extensions_builder to Dart Project

Source: https://pub.dev/packages/theme_extensions_builder/install

Use this command to add the package as a dependency in your Dart project.

```bash
$ dart pub add theme_extensions_builder
```

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

### Android Studio / IntelliJ IDEA File Nesting Configuration

Source: https://pub.dev/packages/theme_extensions_builder

Configure Android Studio or IntelliJ IDEA's file nesting settings to group generated `.g.theme.dart` files with their source `.dart` files. This enhances project navigation.

```plaintext
1. Go to **Settings** → **Editor** → **File Nesting**
2. Add pattern: `*.dart` → `${name}.g.theme.dart`

```

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

### Using constant annotations for theme extensions

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Use the predefined constants @themeExtensions and @themeGen as shorthand for their respective annotation classes.

```dart
// Instead of @ThemeExtensions()
@themeExtensions
class MyTheme extends ThemeExtension<MyTheme> with _$MyTheme {
  // ...
}

// Instead of @ThemeGen()
@themeGen
class MyThemeData with _$MyThemeData {
  // ...
}

```

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

### Add theme_extensions_builder to Flutter Project

Source: https://pub.dev/packages/theme_extensions_builder/install

Use this command to add the package as a dependency in your Flutter project.

```bash
$ flutter pub add theme_extensions_builder
```

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

### Add theme_extensions_builder_annotation to Dart Project

Source: https://pub.dev/packages/theme_extensions_builder_annotation/install

Use this command to add the package as a dependency in your Dart project.

```bash
$ dart pub add theme_extensions_builder_annotation
```

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

### Add theme_extensions_builder_annotation to Flutter Project

Source: https://pub.dev/packages/theme_extensions_builder_annotation/install

Use this command to add the package as a dependency in your Flutter project.

```bash
$ flutter pub add theme_extensions_builder_annotation
```

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

### Import theme_extensions_builder_annotation in Dart Code

Source: https://pub.dev/packages/theme_extensions_builder_annotation/install

Import the package into your Dart files to use its annotations.

```dart
import 'package:theme_extensions_builder_annotation/theme_extensions_builder_annotation.dart';
```

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

### Define Custom Button Theme with Constructor

Source: https://pub.dev/packages/theme_extensions_builder

Use @ThemeExtensions with a custom constructor to define a ButtonTheme. This allows for private constructors and factory constructors for user convenience.

```dart
@ThemeExtensions(constructor: '_internal')
class ButtonTheme extends ThemeExtension<ButtonTheme> with _$ButtonTheme {
  const ButtonTheme._internal({
    required this.backgroundColor,
    required this.foregroundColor,
  });

  final Color backgroundColor;
  final Color foregroundColor;

  // Factory constructor for user convenience
  factory ButtonTheme({
    required Color backgroundColor,
    required Color foregroundColor,
  }) = ButtonTheme._internal;
}
```

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

### Add theme_extensions_builder_annotation to pubspec.yaml

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Add this package to your dependencies using flutter pub add or by manually editing pubspec.yaml.

```bash
flutter pub add theme_extensions_builder_annotation

```

```yaml
dependencies:
  theme_extensions_builder_annotation: ^7.3.0

```

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

### Generate ThemeExtension with @ThemeExtensions

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Use the @ThemeExtensions annotation to generate a ThemeExtension class with full functionality. Ensure to import necessary packages and part files.

```dart
import 'package:flutter/material.dart';
import 'package:theme_extensions_builder_annotation/theme_extensions_builder_annotation.dart';

part 'my_theme.g.theme.dart';

@ThemeExtensions()
class MyTheme extends ThemeExtension<MyTheme> with _$MyTheme {
  const MyTheme({
    required this.primaryColor,
    required this.spacing,
  });

  final Color primaryColor;
  final double spacing;
}

```

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

### Define a Theme Extension Class

Source: https://pub.dev/packages/theme_extensions_builder

Define your theme extension class by annotating it with `@ThemeExtensions()`. This class will have its boilerplate code generated automatically. Ensure it extends `ThemeExtension<YourClassName>` and mixes in `_.$YourClassName`.

```dart
@ThemeExtensions()
class AppTheme extends ThemeExtension<AppTheme> with _$AppTheme {
  const AppTheme({
    required this.primaryColor,
    required this.secondaryColor,
    required this.spacing,
    this.borderRadius,
  });

  final Color primaryColor;
  final Color secondaryColor;
  final double spacing;
  final BorderRadius? borderRadius;
}
```

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

### Initialize Flutter App and Set Time Dilation

Source: https://pub.dev/packages/theme_extensions_builder/example

This snippet initializes the Flutter application and sets the time dilation for animations. Ensure WidgetsFlutterBinding is initialized before running the app.

```dart
import 'package:flutter/material.dart';
import 'package:flutter/scheduler.dart';

import 'app.dart';

void main() {
  timeDilation = 2.0;
  WidgetsFlutterBinding.ensureInitialized();

  runApp(const App());
}
```

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

### Define Alert Theme Data with @ThemeGen

Source: https://pub.dev/packages/theme_extensions_builder

Use the @ThemeGen annotation for theme data classes that do not extend ThemeExtension. It provides default values for properties and a static lerp method.

```dart
@ThemeGen()
class AlertThemeData with _$AlertThemeData {
  const AlertThemeData({
    this.transitionDuration = const Duration(milliseconds: 300),
    this.iconPadding,
    this.titleTextStyle,
    this.borderRadius,
  });

  final Duration transitionDuration;
  final EdgeInsetsGeometry? iconPadding;
  final TextStyle? titleTextStyle;
  final double? borderRadius;

  static AlertThemeData? lerp(AlertThemeData? a, AlertThemeData? b, double t) =>
      _$AlertThemeData.lerp(a, b, t);
}
```

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

### Custom constructor with @ThemeExtensions

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Specify a custom constructor name for the generated ThemeExtension class using the constructor parameter in the @ThemeExtensions annotation.

```dart
// Custom constructor
@ThemeExtensions(constructor: '_internal')
class MyTheme extends ThemeExtension<MyTheme> with _$MyTheme {
  const MyTheme._internal({required this.primaryColor});
  
  final Color primaryColor;
  
  factory MyTheme({required Color primaryColor}) = MyTheme._internal;
}

```

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

### Access Theme Extension via BuildContext

Source: https://pub.dev/packages/theme_extensions_builder

Utilize the generated `BuildContext` extension to easily access your custom theme properties within your widgets. This provides a type-safe and convenient way to retrieve theme data.

```dart
class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // Generated BuildContext extension for easy access
    final appTheme = context.appTheme;
    
    return Container(
      padding: EdgeInsets.all(appTheme.spacing),
      decoration: BoxDecoration(
        color: appTheme.primaryColor,
        borderRadius: appTheme.borderRadius,
      ),
      child: Text('Hello World'),
    );
  }
}
```

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

### Generate theme data classes with @ThemeGen

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Use the @ThemeGen annotation for theme data classes that do not extend ThemeExtension. It generates boilerplate code for theme data.

```dart
import 'package:flutter/material.dart';
import 'package:theme_extensions_builder_annotation/theme_extensions_builder_annotation.dart';

part 'alert_theme.g.theme.dart';

@ThemeGen()
class AlertThemeData with _$AlertThemeData {
  const AlertThemeData({
    this.duration = const Duration(milliseconds: 300),
    this.padding,
    this.textStyle,
  });

  final Duration duration;
  final EdgeInsets? padding;
  final TextStyle? textStyle;

  static AlertThemeData lerp(AlertThemeData? a, AlertThemeData? b, double t) =>
      _$AlertThemeData.lerp(a, b, t);
}

```

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

### Add Theme Extension to ThemeData

Source: https://pub.dev/packages/theme_extensions_builder

Incorporate your custom theme extension into the `ThemeData` for both light and dark themes. This makes your theme accessible throughout the application.

```dart
final lightTheme = ThemeData.light().copyWith(
  extensions: [
    AppTheme(
      primaryColor: Colors.blue,
      secondaryColor: Colors.green,
      spacing: 16.0,
      borderRadius: BorderRadius.circular(8.0),
    ),
  ],
);

final darkTheme = ThemeData.dark().copyWith(
  extensions: [
    AppTheme(
      primaryColor: Colors.indigo,
      secondaryColor: Colors.teal,
      spacing: 16.0,
      borderRadius: BorderRadius.circular(8.0),
    ),
  ],
);
```

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

### Custom context accessor name with @ThemeExtensions

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Customize the name of the BuildContext extension for accessing theme data by providing a contextAccessorName to the @ThemeExtensions annotation.

```dart
// Custom context accessor name
@ThemeExtensions(contextAccessorName: 'customTheme')
class MyTheme extends ThemeExtension<MyTheme> with _$MyTheme {
  // Access via: context.customTheme
}

```

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

### Disable BuildContext extension with @ThemeExtensions

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Disable the automatic BuildContext extension generation by setting buildContextExtension to false in the @ThemeExtensions annotation. Access theme data manually.

```dart
// Disable BuildContext extension
@ThemeExtensions(buildContextExtension: false)
class MyTheme extends ThemeExtension<MyTheme> with _$MyTheme {
  // Manual access: Theme.of(context).extension<MyTheme>()!
}

```

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

### Ignore fields with @ignore annotation

Source: https://pub.dev/packages/theme_extensions_builder_annotation

Use the @ignore annotation on a field to exclude it from all generated methods like copyWith, lerp, merge, ==, and hashCode.

```dart
@ThemeExtensions()
class AppTheme extends ThemeExtension<AppTheme> with _$AppTheme {
  const AppTheme({
    required this.primaryColor,
    this.debugLabel = '',
  });

  final Color primaryColor;

  @ignore
  final String debugLabel; // excluded from generated code
}

```
Tokens:
Raw