CheckboxListTile class Null safety

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 ThemeData.toggleableActiveColor 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.:

Container(
  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.

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.

To create a local project with this code sample, run:
flutter create --sample=material.CheckboxListTile.3 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.

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

Constructors

CheckboxListTile({Key? key, required bool? value, required ValueChanged<bool?>? onChanged, Color? activeColor, Color? checkColor, bool? enabled, Color? tileColor, Widget? title, Widget? subtitle, bool isThreeLine = false, bool? dense, Widget? secondary, bool selected = false, ListTileControlAffinity controlAffinity = ListTileControlAffinity.platform, bool autofocus = false, EdgeInsetsGeometry? contentPadding, bool tristate = false, ShapeBorder? shape, OutlinedBorder? checkboxShape, Color? selectedTileColor, BorderSide? side, VisualDensity? visualDensity, FocusNode? focusNode, bool? enableFeedback}): Creates a combination of a list tile and a checkbox.
const

Properties

activeColor → Color?: The color to use when this checkbox is checked.
final
autofocus → bool: True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
checkboxShape → OutlinedBorder?: The shape of the checkbox's Material.
final
checkColor → Color?: The color to use for the check icon when this checkbox is checked.
final
contentPadding → EdgeInsetsGeometry?: Defines insets surrounding the tile's contents.
final
controlAffinity → ListTileControlAffinity: Where to place the control relative to the text.
final
dense → bool?: Whether this list tile is part of a vertically dense list.
final
enabled → bool?: Whether the CheckboxListTile is interactive.
final
enableFeedback → bool?: Whether detected gestures should provide acoustic and/or haptic feedback.
final
focusNode → FocusNode?: An optional focus node to use as the focus node for this widget.
final
hashCode → int: The hash code for this object.
nonVirtual">@nonVirtualread-onlyinherited
isThreeLine → bool: Whether this list tile is intended to display three lines of text.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onChanged → ValueChanged<bool?>?: Called when the value of the checkbox should change.
final
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
secondary → Widget?: A widget to display on the opposite side of the tile from the checkbox.
final
selected → bool: Whether to render icons and text in the activeColor.
final
selectedTileColor → Color?: If non-null, defines the background color when CheckboxListTile.selected is true.
final
shape → ShapeBorder?: Defines the tile's InkWell.customBorder and Ink.decoration shape.
final
side → BorderSide?: The color and width of the checkbox's border.
final
subtitle → Widget?: Additional content displayed below the title.
final
tileColor → Color?: Defines the background color of ListTile when selected is false.
final
title → Widget?: The primary content of the list tile.
final
tristate → bool: If true the checkbox's value can be true, false, or null.
final
value → bool?: Whether this checkbox is checked.
final
visualDensity → VisualDensity?: Defines how compact the list tile's layout will be.
final

Methods

build(BuildContext context) → Widget: Describes the part of the user interface represented by 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.
protected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → 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 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}) → 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.
nonVirtual">@nonVirtualinherited

Flutter
material
CheckboxListTile class