CheckboxListTile class

A ListTile with a Checkbox. In other words, a checkbox with a label.

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

The value, onChanged, activeColor and checkColor properties of this widget are identical to the similarly-named properties on the Checkbox widget.

The title, subtitle, isThreeLine, dense, and contentPadding 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 CheckboxThemeData.overlayColor if activeColor is null.

This widget does not coordinate the selected state and the value state; to have the list tile appear selected when the checkbox is checked, pass the same value to both.

The checkbox is shown on the right by default in left-to-right languages (i.e. the trailing edge). This can be changed using controlAffinity. The secondary widget is placed on the opposite side. This maps to the ListTile.leading and ListTile.trailing properties of ListTile.

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 CheckboxListTile itself but by the Material widget ancestor. In this case, one can wrap a Material widget around the CheckboxListTile, e.g.:

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

Performance considerations when wrapping CheckboxListTile with Material

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

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

This widget shows a checkbox that, when checked, slows down all animations (including the animation of the checkbox itself getting checked!).

This sample requires that you also import 'package:flutter/scheduler.dart', so that you can reference timeDilation.

link

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

Semantics in CheckboxListTile

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

To do so, a CheckboxListTile 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, CheckboxListTile 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 CheckboxListTile. RichText has an embedded gesture recognizer that requires its own Semantics node, which directly conflicts with CheckboxListTile'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 checkbox widget, called LinkedLabelCheckbox, 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.CheckboxListTile.4 mysample

CheckboxListTile isn't exactly what I want

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

Here is an example of a custom LabeledCheckbox 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.CheckboxListTile.5 mysample

See also:

• ListTileTheme, which can be used to affect the style of list tiles, including checkbox list tiles.
• RadioListTile, a similar widget for radio buttons.
• SwitchListTile, a similar widget for switches.
• ListTile and Checkbox, the widgets from which this widget is made.