A material design switch.
Used to toggle the on/off state of a single setting.
The switch itself does not maintain any state. Instead, when the state of the switch changes, the widget calls the onChanged callback. Most widgets that use a switch will listen for the onChanged callback and rebuild the switch with a new value to update the visual appearance of the switch.
Requires one of its ancestors to be a Material widget.
See also:
- Inheritance
- Object
- Widget
- StatefulWidget
- Switch
Constructors
- Switch({Key key, @required bool value, @required ValueChanged<bool> onChanged, Color activeColor, ImageProvider activeThumbImage, ImageProvider inactiveThumbImage })
-
Creates a material design switch.
Properties
- activeColor → Color
-
The color to use when this switch is on.
read-only - activeThumbImage → ImageProvider
-
An image to use on the thumb of this switch when the switch is on.
read-only - inactiveThumbImage → ImageProvider
-
An image to use on the thumb of this switch when the switch is off.
read-only - onChanged → ValueChanged<bool>
-
Called when the user toggles with switch on or off.
read-only - value → bool
-
Whether this switch is on or off.
read-only - hashCode → int
-
Get a hash code for this object.
read-only, inherited - key → Key
-
Controls how one widget replaces another widget in the tree.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
createState(
) → _SwitchState -
Creates the mutable state for this widget at a given location in the tree.
-
debugFillDescription(
List<String> description) → void -
Add additional information to the given description for use by
toString. -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
toString(
) → String -
Returns a string representation of this object.
inherited -
toStringShort(
) → String -
A short, textual description of this widget.
inherited