A ListTile with a Switch. In other words, a switch with a label.

The entire list tile is interactive: tapping anywhere in the tile toggles the switch.

The value, onChanged, activeColor, activeThumbImage, and inactiveThumbImage properties of this widget are identical to the similarly-named properties on the Switch widget.

The title, subtitle, isThreeLine, and dense properties are like those of the same name on ListTile.

The selected property on this widget is similar to the ListTile.selected property, but the color used is that described by activeColor, if any, defaulting to the accent color of the current Theme. No effort is made to coordinate the selected state and the value state; to have the list tile appear selected when the switch is on, pass the same value to both.

The switch is shown on the right by default in left-to-right languages (i.e. in the ListTile.trailing slot). The secondary widget is placed in the ListTile.leading slot. This cannot be changed; there is not sufficient space in a ListTile's ListTile.leading slot for a Switch.

To show the SwitchListTile as disabled, pass null as the onChanged callback.

Sample code

This widget shows a switch that, when toggled, changes the state of a bool member field called _lights.

new SwitchListTile(
  title: const Text('Lights'),
  value: _lights,
  onChanged: (bool value) { setState(() { _lights = value; }); },
  secondary: const Icon(Icons.lightbulb_outline),
)

See also:

Inheritance

Constructors

SwitchListTile({Key key, @required bool value, @required ValueChanged<bool> onChanged, Color activeColor, ImageProvider activeThumbImage, ImageProvider inactiveThumbImage, Widget title, Widget subtitle, bool isThreeLine: false, bool dense, Widget secondary, bool selected: false })
Creates a combination of a list tile and a switch. [...]
const

Properties

activeColor Color
The color to use when this switch is on. [...]
final
activeThumbImage ImageProvider
An image to use on the thumb of this switch when the switch is on.
final
dense bool
Whether this list tile is part of a vertically dense list. [...]
final
inactiveThumbImage ImageProvider
An image to use on the thumb of this switch when the switch is off.
final
isThreeLine bool
Whether this list tile is intended to display three lines of text. [...]
final
onChanged ValueChanged<bool>
Called when the user toggles the switch on or off. [...]
final
secondary Widget
A widget to display on the opposite side of the tile from the switch. [...]
final
selected bool
Whether to render icons and text in the activeColor. [...]
final
subtitle Widget
Additional content displayed below the title. [...]
final
title Widget
The primary content of the list tile. [...]
final
value bool
Whether this switch is checked. [...]
final
hashCode int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder description) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) 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 ==(other) bool
The equality operator. [...]
inherited