ProviderListener<T> class

A widget that allows listening to a provider.

A common use-case is to use ProviderListener to push routes/modals/snackbars when the value of a provider changes.

Even if a provider changes many times in a quick succession, onChange will be called only once, at the end of the frame.

Inheritance
Annotations
  • @Deprecated('Use WidgetRef.listen instead')
  • @sealed

Constructors

ProviderListener({Key? key, required OnProviderChange<T> onChange, required ProviderListenable<T>? provider, required Widget child})
A widget that allows listening to a provider.
const

Properties

child → Widget
The descendant of this ProviderListener
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChange → OnProviderChange<T>
A function called with the new value of provider when it changes.
final
provider → ProviderListenable<T>?
The provider listened.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context, WidgetRef ref) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → ConsumerStatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _ConsumerState
Creates the mutable state for this widget at a given location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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