SwitchListTile class

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. Tapping and dragging the Switch also triggers the onChanged callback.

To ensure that onChanged correctly triggers, the state passed into value must be properly managed. This is typically done by invoking State.setState in onChanged to toggle the state value.

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. This tile's activeColor is used for the selected item's text color, or the theme's SwitchThemeData.overlayColor if activeColor is null.

This widget does not coordinate the selected state and the value; to have the list tile appear selected when the switch button is on, use the same value for both.

The switch is shown on the right by default in left-to-right languages (i.e. in the ListTile.trailing slot) which can be changed using controlAffinity. The secondary widget is placed in the ListTile.leading slot.

This widget requires a Material widget ancestor in the tree to paint itself on, which is typically provided by the app's Scaffold. The tileColor, and selectedTileColor are not painted by the SwitchListTile itself but by the Material widget ancestor. In this case, one can wrap a Material widget around the SwitchListTile, e.g.:

ColoredBox(
  color: Colors.green,
  child: Material(
    child: SwitchListTile(
      tileColor: Colors.red,
      title: const Text('SwitchListTile with red background'),
      value: true,
      onChanged:(bool? value) { },
    ),
  ),
)

Performance considerations when wrapping SwitchListTile with Material

Wrapping a large number of SwitchListTiles individually with Materials is expensive. Consider only wrapping the SwitchListTiles that require it or include a common Material ancestor where possible.

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

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

link

To create a local project with this code sample, run:
flutter create --sample=material.SwitchListTile.2 mysample

Semantics in SwitchListTile

Since the entirety of the SwitchListTile is interactive, it should represent itself as a single interactive entity.

To do so, a SwitchListTile widget wraps its children with a MergeSemantics widget. MergeSemantics will attempt to merge its descendant Semantics nodes into one node in the semantics tree. Therefore, SwitchListTile will throw an error if any of its children requires its own Semantics node.

For example, you cannot nest a RichText widget as a descendant of SwitchListTile. RichText has an embedded gesture recognizer that requires its own Semantics node, which directly conflicts with SwitchListTile's desire to merge all its descendants' semantic nodes into one. Therefore, it may be necessary to create a custom radio tile widget to accommodate similar use cases.

Here is an example of a custom labeled radio widget, called LinkedLabelRadio, that includes an interactive RichText widget that handles tap gestures.

link

To create a local project with this code sample, run:
flutter create --sample=material.SwitchListTile.4 mysample

SwitchListTile isn't exactly what I want

If the way SwitchListTile pads and positions its elements isn't quite what you're looking for, you can create custom labeled switch widgets by combining Switch with other widgets, such as Text, Padding and InkWell.

Here is an example of a custom LabeledSwitch widget, but you can easily make your own configurable widget.

link

To create a local project with this code sample, run:
flutter create --sample=material.SwitchListTile.5 mysample

See also:

• ListTileTheme, which can be used to affect the style of list tiles, including switch list tiles.
• CheckboxListTile, a similar widget for checkboxes.
• RadioListTile, a similar widget for radio buttons.
• ListTile and Switch, the widgets from which this widget is made.