LogoSignals.dart
Copy Markdown
rodydavis/signals.dart 999999

SignalBuilder

A premium, surgical builder widget that rebuilds locally on signal changes.

A premium, surgical builder widget that rebuilds locally on signal changes.

SignalBuilder tracks any signals read dynamically within its builder callback and automatically subscribes to them. When any of these signals update, only the SignalBuilder is rebuilt, preventing costly rebuilds of the surrounding widget subtree.

This widget provides predictable, immediate, and memory-safe subscription management, automatically tearing down all active signal subscriptions when the builder is unmounted.

Surgical Counter Example#

final count = signal(0);

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Counter')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text('This static text never rebuilds!'),
            const SizedBox(height: 20),
            // Only this specific Text widget rebuilds when 'count' changes:
            SignalBuilder(
              builder: (context) => Text(
                'Count: ${count.value}',
                style: Theme.of(context).textTheme.headlineMedium,
              ),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () => count.value++,
        child: const Icon(Icons.add),
      ),
    );
  }
}

Tip

Keep SignalBuilder widgets as small and leaf-level as possible in your tree to maximize rendering performance.

Constructors#

View Constructors
SignalBuilder({super.key, required this.builder, this.dependencies = const []})

Creates a SignalBuilder widget.

The builder is called to construct the widget tree and tracks read signals. The optional dependencies allows explicitly specifying a list of signals to watch regardless of whether they are read during the build phase.

Properties#

View Properties
Widget Function(BuildContext context) builder

The widget to rebuild when any signals change.

List<core.ReadonlySignal> dependencies

List of optional dependencies to watch.

Methods#

View Methods
Widget build(BuildContext context)