Skip to main content

circuitry_flutter 0.1.0 copy "circuitry_flutter: ^0.1.0" to clipboard
circuitry_flutter: ^0.1.0 copied to clipboard

Flutter bridge for Circuitry with InheritedWidget scoping, reactive state matching, and async lifecycle management.

Circuitry Flutter #

pub package License: MIT

Flutter bridge for circuitry — providing InheritedWidget scoping, reactive CircuitState pattern matching, compilation epoch race prevention, and automatic unmount disposal.


Architecture Overview #

Circuitry Architecture


Features #

  • Sealed CircuitState Hierarchy: Pattern match CircuitBuilding, CircuitReady, and CircuitFailure using Dart 3 switch expressions.
  • Asynchronous Build Lifecycle (CircuitProvider): Compiles CircuitWire recipes asynchronously, displays loading/splash state while resolving, and wraps child in an internal InheritedWidget scope once ready.
  • Monotonic Epoch Race Prevention: Handles dynamic widget wire updates (didUpdateWidget) without race conditions, safely discarding superseded in-flight builds.
  • Automatic Unmount Cleanup: Automatically calls circuit.dispose() when the provider is unmounted from the widget tree.
  • Synchronous Value Injection (CircuitProvider.value): Injects an already resolved Circuit synchronously for test harnesses or sub-trees without managing lifecycle disposal.
  • Explicit Accessors: Retrieve dependencies via CircuitProvider.of(context) and CircuitProvider.maybeOf(context) without BuildContext extension pollution.

Installation #

flutter pub add circuitry_flutter

Quickstart #

import 'package:circuitry_flutter/circuitry_flutter.dart';
import 'package:flutter/widgets.dart';

void main() {
  runApp(const MyApp());
}

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

  static final _defaultWires = [
    Wire(() => DatabaseConfig('app.db')),
    AsyncWire.takes<DatabaseConfig>().to(DatabaseManager.open),
  ];

  @override
  Widget build(BuildContext context) {
    return CircuitProvider(
      wires: _defaultWires,
      builder: (context, state) => switch (state) {
        CircuitReady(:final circuit) => const HomeScreen(),
        CircuitBuilding() => const SplashScreen(),
        CircuitFailure(:final error) => ErrorScreen(error: error),
      },
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    final circuit = CircuitProvider.of(context);
    final db = circuit.get<DatabaseService>();

    return Center(
      child: Text('Database active: ${db.path}'),
    );
  }
}

License #

MIT © Raman Verma

0
likes
160
points
--
downloads

Documentation

API reference

Publisher

verified publishermaranix.in

Weekly Downloads

Flutter bridge for Circuitry with InheritedWidget scoping, reactive state matching, and async lifecycle management.

Homepage
Repository (GitHub)
View/report issues

Topics

#dependency-injection #di #ioc #flutter #state-management

License

MIT (license)

Dependencies

circuitry, flutter

More

Packages that depend on circuitry_flutter