ConsumerWidget class abstract

A StatelessWidget that can listen to providers.

Using ConsumerWidget, this allows the widget tree to listen to changes on provider, so that the UI automatically updates when needed.

Do not modify any state or start any http request inside build.

As a usage example, consider:

final helloWorldProvider = Provider((_) => 'Hello world');

We can then subclass ConsumerWidget to listen to helloWorldProvider like so:

class Example extends ConsumerWidget {
  const Example({Key? key}): super(key: key);

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final value = ref.watch(helloWorldProvider);
    return Text(value); // Hello world
  }
}

Note You can watch as many providers inside build as you want to:

@override
Widget build(BuildContext context, WidgetRef ref) {
  final value = ref.watch(someProvider);
  final another = ref.watch(anotherProvider);
  return Text(value); // Hello world
}

For reading providers inside a StatefulWidget or for performance optimizations, see Consumer.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• ConsumerStatefulWidget
• ConsumerWidget

Implementers

• HookConsumerWidget

Constructors

ConsumerWidget({Key? key})

A StatelessWidget that can listen to providers.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build(BuildContext context, WidgetRef ref) → Widget

Describes the part of the user interface represented by this widget.

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.

override

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, int wrapWidth = 65}) → 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