M3ESelection class
Host widget that wires M3ESelectionAppBar and any list body to one M3ESelectionController.
Prefer wrapping the route with PopScope so system back clears selection instead of popping:
PopScope(
canPop: !controller.isSelectionMode,
onPopInvokedWithResult: (didPop, _) {
if (!didPop) controller.clear();
},
child: M3ESelection(
controller: controller,
itemCount: items.length,
appBar: M3ESelectionAppBar(...),
body: M3ECardList.builder(...),
),
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- M3ESelection
Constructors
- M3ESelection({required M3ESelectionAppBar appBar, required Widget body, required int itemCount, M3ESelectionController? controller, bool scaffold = true, Color? backgroundColor, Color? selectedColor, bool? resizeToAvoidBottomInset, Key? key})
-
Creates a selection host.
const
Properties
- appBar → M3ESelectionAppBar
-
Idle / contextual app bar wrapper.
final
- backgroundColor → Color?
-
Scaffold background color when scaffold is true.
final
- body → Widget
-
Any list body (card list, dismissible list, etc.).
final
- controller → M3ESelectionController?
-
Optional external controller. When null, one is owned internally.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- itemCount → int
-
Item count for select-all / M3ESelectionScope.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- resizeToAvoidBottomInset → bool?
-
Forwarded to Scaffold.resizeToAvoidBottomInset.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scaffold → bool
-
When true (default), builds a scaffold whose body is header + list.
The selection header is not placed in the scaffold app-bar slot so idle
can be any intrinsic-height widget. Set false to embed under a host scaffold.
final
- selectedColor → Color?
-
Fill used for selected list items. Overrides the selection theme highlight.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< M3ESelection> -
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