M3ESegmentedButton<T> class
A Material 3 Expressive segmented button.
Presents 2–5 connected M3ESegments for selecting options, switching views or sorting. Supports single or multiple selection and shows a check icon on selected segments when showSelectedIcon is true.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- M3ESegmentedButton
Constructors
-
M3ESegmentedButton({required List<
M3ESegment< segments, required Set<T> >T> selected, required ValueChanged<Set< onSelectionChanged, bool multiSelect = false, bool showSelectedIcon = true, M3ESegmentedButtonDensity density = M3ESegmentedButtonDensity.regular, bool enabled = true, String? semanticLabel, Key? key})T> > -
Creates a segmented button.
const
Properties
- density → M3ESegmentedButtonDensity
-
Density level that shrinks container height (−4dp per step).
final
- enabled → bool
-
When false, the whole group is disabled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- multiSelect → bool
-
When true, multiple segments may be selected (including none).
final
-
onSelectionChanged
→ ValueChanged<
Set< T> > -
Called when selection changes.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
segments
→ List<
M3ESegment< T> > -
Segments rendered in reading order (2–5).
final
-
selected
→ Set<
T> -
Currently selected values.
final
- semanticLabel → String?
-
Optional accessibility label for the group.
final
- showSelectedIcon → bool
-
When true, selected segments show a checkmark (replacing the category icon).
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< M3ESegmentedButton< T> > -
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