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, 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 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.

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

CheckboxListTile sample

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.

import 'package:flutter/scheduler.dart' show timeDilation;

// ...

@override
Widget build(BuildContext context) {
  return Center(
    child: CheckboxListTile(
      title: const Text('Animate Slowly'),
      value: timeDilation != 1.0,
      onChanged: (bool value) {
        setState(() { timeDilation = value ? 10.0 : 1.0; });
      },
      secondary: const Icon(Icons.hourglass_empty),
    ),
  );
}

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.

Checkbox list tile semantics sample

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

import 'package:flutter/gestures.dart';

// ...

class LinkedLabelCheckbox extends StatelessWidget {
  const LinkedLabelCheckbox({
    this.label,
    this.padding,
    this.value,
    this.onChanged,
  });

  final String label;
  final EdgeInsets padding;
  final bool value;
  final Function onChanged;

  @override
  Widget build(BuildContext context) {
    return Padding(
      padding: padding,
      child: Row(
        children: <Widget>[
          Expanded(
            child: RichText(
              text: TextSpan(
                text: label,
                style: TextStyle(
                  color: Colors.blueAccent,
                  decoration: TextDecoration.underline,
                ),
                recognizer: TapGestureRecognizer()
                  ..onTap = () {
                  print('Label has been tapped.');
                },
              ),
            ),
          ),
          Checkbox(
            value: value,
            onChanged: (bool newValue) {
              onChanged(newValue);
            },
          ),
        ],
      ),
    );
  }
}

// ...

bool _isSelected = false;

@override
Widget build(BuildContext context) {
  return Scaffold(
    body: Center(
      child: LinkedLabelCheckbox(
        label: 'Linked, tappable label text',
        padding: const EdgeInsets.symmetric(horizontal: 20.0),
        value: _isSelected,
        onChanged: (bool newValue) {
          setState(() {
            _isSelected = newValue;
          });
        },
      ),
    ),
  );
}

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.

Custom checkbox list tile sample

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

class LabeledCheckbox extends StatelessWidget {
  const LabeledCheckbox({
    this.label,
    this.padding,
    this.value,
    this.onChanged,
  });

  final String label;
  final EdgeInsets padding;
  final bool value;
  final Function onChanged;

  @override
  Widget build(BuildContext context) {
    return InkWell(
      onTap: () {
        onChanged(!value);
      },
      child: Padding(
        padding: padding,
        child: Row(
          children: <Widget>[
            Expanded(child: Text(label)),
            Checkbox(
              value: value,
              onChanged: (bool newValue) {
                onChanged(newValue);
              },
            ),
          ],
        ),
      ),
    );
  }
}

// ...

bool _isSelected = false;

@override
Widget build(BuildContext context) {
  return Scaffold(
    body: Center(
      child: LabeledCheckbox(
        label: 'This is the label text',
        padding: const EdgeInsets.symmetric(horizontal: 20.0),
        value: _isSelected,
        onChanged: (bool newValue) {
          setState(() {
            _isSelected = newValue;
          });
        },
      ),
    ),
  );
}

See also:

Inheritance

Constructors

CheckboxListTile({Key key, @required bool value, @required ValueChanged<bool> onChanged, Color activeColor, Color checkColor, Widget title, Widget subtitle, bool isThreeLine: false, bool dense, Widget secondary, bool selected: false, ListTileControlAffinity controlAffinity: ListTileControlAffinity.platform })
Creates a combination of a list tile and a checkbox. [...]
const

Properties

activeColor Color
The color to use when this checkbox is checked. [...]
final
checkColor Color
The color to use for the check icon when this checkbox is checked. [...]
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
isThreeLine bool
Whether this list tile is intended to display three lines of text. [...]
final
onChanged ValueChanged<bool>
Called when the value of the checkbox should change. [...]
final
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
subtitle Widget
Additional content displayed below the title. [...]
final
title Widget
The primary content of the list tile. [...]
final
value bool
Whether this checkbox 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. [...]
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, inherited
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.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 ==(dynamic other) bool
The equality operator. [...]
inherited