ConsumerState<WidgetT extends ConsumerStatefulWidget> class abstract Core

The State for a ConsumerStatefulWidget.

It has all the life-cycles if a normal State, with the only difference being that it has a ref property.

It must be used in conjunction with a ConsumerStatefulWidget :

class MyConsumer extends ConsumerStatefulWidget {
 const MyConsumer({Key? key}): super(key: key);

  @override
  ConsumerState<MyConsumer> createState() => _MyConsumerState();
}

class _MyConsumerState extends ConsumerState<MyConsumer> {
  @override
  void initState() {
    // All State life-cycles can be used
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    // "ref" is a property of ConsumerState and can be used to read providers
    ref.watch(someProvider);
  }
}
Inheritance

Constructors

ConsumerState()

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
ref → WidgetRef
An object that allows widgets to interact with providers.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
widget → WidgetT
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant WidgetT oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
inherited
initState() → void
Called when this object is inserted into the tree.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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