PlatformSwitch class

A platform-adaptive switch that renders Material Switch on Android and CupertinoSwitch on iOS.

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

• On Android: renders Material Design Switch
• On iOS: renders CupertinoSwitch

The switch can be configured with platform-specific data through materialSwitchData and cupertinoSwitchData, or with common properties.

Example:

PlatformSwitch(
  platformSwitchData: PlatformSwitchData(
    value: _isSwitchOn,
    onChanged: (value) => setState(() => _isSwitchOn = value),
  ),
)

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• PlatformWidgetBase
• PlatformWidgetKeyedBase
• PlatformSwitch

Constructors

PlatformSwitch({PlatformSwitchData? platformSwitchData, MaterialSwitchData? materialSwitchData, CupertinoSwitchData? cupertinoSwitchData, Key? key})

Creates a platform-adaptive switch.

const

Properties

cupertinoSwitchData → CupertinoSwitchData?

Cupertino-specific switch data.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

materialSwitchData → MaterialSwitchData?

Material-specific switch data.

final

platformSwitchData → PlatformSwitchData?

Platform-shared switch data.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

widgetKey → Key?

Optional key applied to the inner platform-specific widget.

final, inherited

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