Search packages, repositories and app categories

Package detailsv7.5.0

theme_extensions_builder_annotation

Annotations for the theme_extensions_builder. This package does nothing without theme_extensions_builder.

AndroidiOSLinuxmacOSWebWindows
30-day downloads
193K
Likes
4
Pub points
160

Install package

flutter pub add theme_extensions_builder_annotation

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Dart package providing annotations for the theme_extensions_builder, enabling streamlined creation and management of theme extensions in Flutter applications. It serves as a companion to theme_extensions_builder, offering compile-time code generation support through annotations. This package itself does not contain executable logic but enhances developer productivity by simplifying theme configuration and reducing boilerplate. It is designed to work exclusively with the theme_extensions_builder package.

Use cases

  • Generating theme extension classes
  • Simplifying theme configuration
  • Enabling type-safe theme handling
  • Reducing boilerplate in theme setup
  • Supporting dynamic theming workflows

Key features

  • Compile-time code generation
  • Integration with theme_extensions_builder
  • Type-safe theme definitions
  • Minimal runtime overhead
  • Annotation-driven development

Suitable for

  • Flutter developers using theme_extensions_builder
  • Teams prioritizing maintainable theme systems
  • Projects requiring scalable theming solutions
  • Developers seeking reduced boilerplate
  • Apps with complex or dynamic theme requirements

Considerations

  • Requires theme_extensions_builder to function
  • No standalone functionality
  • Dependent on build_runner for code generation
  • Limited to use within supported Flutter projects
  • Not suitable for simple static themes

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

theme_extensions_builder

pub package License: MIT

📖 Full documentation: packages/theme_extensions_builder/README.md

theme_extensions_builder is a powerful code generator for Flutter's ThemeExtension classes. It eliminates boilerplate code by automatically generating copyWith, lerp, ==, and hashCode methods, along with convenient BuildContext extensions for easy theme access.

🎯 Quick Links

📦 Installation

Add the packages to your project:

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

Or add to pubspec.yaml:

dependencies:
  theme_extensions_builder_annotation: ^7.5.0

dev_dependencies:
  build_runner: ^2.13.0
  theme_extensions_builder: ^7.5.0

🚀 Quick Start

Using @ThemeExtensions

For classes extending ThemeExtension:

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

part 'app_theme.g.theme.dart';

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

  final Color primaryColor;
  final double spacing;
}

Generate code:

dart run build_runner build

Use in your app:

Widget build(BuildContext context) {
  final theme = context.appTheme;
  
  return Container(
    padding: EdgeInsets.all(theme.spacing),
    color: theme.primaryColor,
  );
}
Using @ThemeGen

For standalone theme data classes:

@ThemeGen()
class ButtonThemeData with _$ButtonThemeData {
  const ButtonThemeData({
    required this.backgroundColor,
    this.borderRadius = 8.0,
  });

  final Color backgroundColor;
  final double borderRadius;

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

📋 Choose Your Annotation

@ThemeExtensions (Recommended)

For classes extending Flutter's ThemeExtension - ideal for most use cases.

Perfect for:

  • Full Flutter theme integration
  • Automatic theme switching with lerp animations
  • Easy access via BuildContext (e.g., context.appTheme)

Generates:

  • Complete ThemeExtension implementation with copyWith and lerp
  • BuildContext extension for convenient access
  • Equality operators and hashCode
@ThemeGen

For standalone theme data classes without ThemeExtension inheritance.

Perfect for:

  • Custom theme systems outside standard Flutter themes
  • Maximum control over class structure
  • Nested theme data objects

Generates:

  • copyWith and merge methods
  • Static lerp method
  • Equality operators and hashCode

📖 Example

Check out the example project for a comprehensive Flutter app with:

  • 5 Theme Extensions: App, Button, Card, Typography, and Spacing themes
  • Theme Switching: Seamless light/dark mode transitions
  • Custom Components: Buttons, cards, and typography showcases
  • Best Practices: Real-world organization patterns

🛠️ Development

The repository is a pub workspace: one flutter pub get at the root resolves every package, including the example app.

flutter pub get
scripts/prepare_push.sh     # format, analyze, build and test every package
scripts/update_goldens.sh   # regenerate the golden files after a generator change

The generator tests run on the Dart SDK alone. The Flutter classes the fixtures use are small stand-ins in packages/theme_extensions_builder/test/fixtures/flutter_stubs.dart, with the same lerp and merge signatures as the real ones. The example app is where the generated code meets the real framework, so CI regenerates and analyzes it on every push.

📄 License

MIT License - see the LICENSE file for details.

Categories

Dependencies

Dependency list 1 items

Source repository

Projects using this package

Rankings