UseStateMixin<T extends StatefulWidget> mixin

A mixin for managing state-related resources in a StatefulWidget. It simplifies the creation and lifecycle management of objects like AnimationControllers, StreamSubscriptions, Timers, and ValueNotifiers.

Superclass constraints

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
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
widget → T
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 T oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Disposes all managed resources upon the disposal of the state.
override
getUseStateScene<P>(String key) UseStateScene<P>?
Retrieves a previously created UseStateScene object. _object is the object that was created with the key. _object is immutable
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
useAnimationController({required String key, required TickerProvider vsync, Duration duration = const Duration(milliseconds: 300)}) AnimationController
Retrieves an existing AnimationController or creates a new one.
useCustomScene<R>({required String key, required R createHandler(), required Future<void> disposeHandler(R)}) → R
Retrieves or creates a custom managed resource.
useNotifier<V>({required String key, required V initialValue}) ValueNotifier<V>
Retrieves an existing ValueNotifier or creates a new one.
usePeriodicTimer({required String key, required void callback(Timer), required Duration duration}) Timer
Retrieves or creates a periodic Timer.
useStreamSubscription<S>({required String key, required Stream<S> stream, required void onData(S event)}) StreamSubscription<S>
Subscribes to a stream and manages the subscription lifecycle.
useTextEditingController({required String key, String? text}) TextEditingController
Retrieves or creates a TextEditingController
useTimer({required String key, required void callback(), required Duration duration}) Timer
Retrieves or creates a one-time Timer.

Operators

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