ValueListenableBuilder<T> class

A widget that rebuilds when a ValueListenable changes its value.

ValueListenableBuilder takes a valueListenable and a builder callback. The builder is called whenever the value changes, providing the current value.

ValueListenableBuilder<int>(
  valueListenable: myCounter,
  builder: (context, value, child) {
    return Text('Count: $value');
  },
)
Inheritance

Constructors

ValueListenableBuilder({required ValueListenable<T> valueListenable, required Widget builder(BuildContext context, T value, Widget? child), Widget? child, Key? key})
Creates a widget that rebuilds when valueListenable notifies.

Properties

builder Widget Function(BuildContext context, T value, Widget? child)
Called every time the valueListenable notifies.
final
child Widget?
An optional child widget that does not depend on the value.
final
children List<Widget>
Child widgets that receive forwarded messages.
no setterinherited
debugRenderObjectPassthrough bool
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
focusable bool
Whether this widget can receive keyboard focus.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id String
Unique identifier for this widget.
no setterinherited
key Key?
Key for preserving widget identity.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
theme Theme
Access the current theme.
no setterinherited
valueListenable ValueListenable<T>
The ValueListenable to which this widget is listening.
final

Methods

buildCachedView<T>(T builder(), Object? cacheKey) → T
Returns a cached view if the cache key matches.
inherited
createState() State<ValueListenableBuilder<T>>
Creates the mutable State associated with this widget.
override
handleInit() Cmd?
Override this instead of init for widget-specific initialization.
inherited
handleIntercept(Msg msg) → (Widget, Cmd?)
Override this to handle messages before they reach children.
inherited
handleUpdate(Msg msg) → (Widget, Cmd?)
Override this to handle messages specific to this widget.
inherited
init() Cmd?
Called once when the widget is first mounted.
inherited
invalidateCachedView() → void
Clears any cached view for this widget.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
update(Msg msg) → (Model, Cmd?)
Handles messages by forwarding to children then calling handleUpdate.
inherited
view() Object
Renders the widget to a string or View.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited