PlatformSegmentButton<T extends Object> class

A platform-adaptive segmented button that renders Material SegmentedButton on Android and CupertinoSlidingSegmentedControl on iOS.

This widget automatically selects the appropriate segmented button implementation based on the target platform:

  • On Android: renders Material Design SegmentedButton
  • On iOS: renders CupertinoSlidingSegmentedControl

The segmented button can be configured with platform-specific data through materialSegmentButtonData and cupertinoSegmentButtonData, or with common properties.

Note: On Android, only supports single selection due to use in CupertinoSlidingSegmentedControl.

Example:

PlatformSegmentButton<String>(
  choices: ['Day', 'Week', 'Month'],
  selectedChoice: _selectedView,
  onSelectionChanged: (choice) => setState(() => _selectedView = choice),
  segmentBuilder: (choice) => Text(choice),
)
Inheritance

Constructors

PlatformSegmentButton({required Iterable<T>? choices, required Widget segmentBuilder(T choice)?, required T? selectedChoice, required ValueChanged<T?>? onSelectionChanged, MaterialSegmentButtonData<T>? materialSegmentButtonData, CupertinoSegmentButtonData<T>? cupertinoSegmentButtonData, Key? widgetKey, Key? key})
Creates a platform-adaptive segmented button.
const

Properties

choices Iterable<T>?
The list of choices to display as segments.
final
cupertinoSegmentButtonData CupertinoSegmentButtonData<T>?
Cupertino-specific segmented button data.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
materialSegmentButtonData MaterialSegmentButtonData<T>?
Material-specific segmented button data.
final
onSelectionChanged ValueChanged<T?>?
Callback when the selected segment changes.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
segmentBuilder Widget Function(T choice)?
Builder function for creating the widget representation of each segment.
final
widgetKey Key?
Optional key applied to the inner platform-specific widget.
finalinherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
inherited
buildCupertino(BuildContext context) Widget
Builds the Cupertino (iOS) variant of this widget.
override
buildMaterial(BuildContext context) Widget
Builds the Material Design (Android) variant of this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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