MaterialStateMixin<T extends StatefulWidget> mixin

Mixin for State classes that require knowledge of changing WidgetState values for their child widgets.

This mixin does nothing by mere application to a State class, but is helpful when writing build methods that include child InkWell, GestureDetector, MouseRegion, or Focus widgets. Instead of manually creating handlers for each type of user interaction, such State classes can instead provide a ValueChanged<bool> function and allow MaterialStateMixin to manage the set of active WidgetStates, and the calling of setState as necessary.

This example shows how to write a StatefulWidget that uses the MaterialStateMixin class to watch WidgetState values.

class MyWidget extends StatefulWidget {
  const MyWidget({super.key, required this.color, required this.child});

  final WidgetStateColor color;
  final Widget child;

  @override
  State<MyWidget> createState() => MyWidgetState();
}

class MyWidgetState extends State<MyWidget> with MaterialStateMixin<MyWidget> {
  @override
  Widget build(BuildContext context) {
    return InkWell(
      onFocusChange: updateMaterialState(WidgetState.focused),
      child: ColoredBox(
        color: widget.color.resolve(materialStates),
        child: widget.child,
      ),
    );
  }
}

Superclass constraints

State<T>

@optionalTypeArgs

Properties

context → BuildContext: The location in the tree where this widget builds.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
isDisabled → bool: Getter for whether this class considers WidgetState.disabled to be active.
no setter
isDragged → bool: Getter for whether this class considers WidgetState.dragged to be active.
no setter
isErrored → bool: Getter for whether this class considers WidgetState.error to be active.
no setter
isFocused → bool: Getter for whether this class considers WidgetState.focused to be active.
no setter
isHovered → bool: Getter for whether this class considers WidgetState.hovered to be active.
no setter
isPressed → bool: Getter for whether this class considers WidgetState.pressed to be active.
no setter
isScrolledUnder → bool: Getter for whether this class considers WidgetState.scrolledUnder to be active.
no setter
isSelected → bool: Getter for whether this class considers WidgetState.selected to be active.
no setter
materialStates ↔ Set<WidgetState>: Managed set of active WidgetState values; designed to be passed to WidgetStateProperty.resolve methods.
getter/setter pair
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
addMaterialState(WidgetState state) → void: Mutator to mark a WidgetState value as active.
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.
override
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: 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
removeMaterialState(WidgetState state) → void: Mutator to mark a WidgetState value as inactive.
setMaterialState(WidgetState state, bool isSet) → void: Mutator to mark a WidgetState value as either active or inactive.
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
updateMaterialState(WidgetState key, {ValueChanged<bool>? onChanged}) → ValueChanged<bool>: Callback factory which accepts a WidgetState value and returns a closure to mutate materialStates and call setState.

Operators

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

MaterialStateMixin<T extends StatefulWidget> mixin

Properties

Methods

Operators

material library