ChoiceChip class

A Material Design choice chip.

ChoiceChips represent a single choice from a set. Choice chips contain related descriptive text or categories.

Requires one of its ancestors to be a Material widget.

This example shows how to create ChoiceChips with onSelected. When the user taps, the chip will be selected.

To see it in action, copy and run this code snippet on DartPad.

import 'package:material_ui/material_ui.dart';

/// Flutter code sample for [ChoiceChip].

void main() => runApp(const ChipApp());

class ChipApp extends StatelessWidget {
  const ChipApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(colorSchemeSeed: const Color(0xff6750a4)),
      home: const ActionChoiceExample(),
    );
  }
}

class ActionChoiceExample extends StatefulWidget {
  const ActionChoiceExample({super.key});

  @override
  State<ActionChoiceExample> createState() => _ActionChoiceExampleState();
}

class _ActionChoiceExampleState extends State<ActionChoiceExample> {
  int? _value = 1;

  @override
  Widget build(BuildContext context) {
    final TextTheme textTheme = Theme.of(context).textTheme;

    return Scaffold(
      appBar: AppBar(title: const Text('ActionChoice Sample')),
      body: Center(
        child: Column(
          crossAxisAlignment: .start,
          mainAxisAlignment: .center,
          children: <Widget>[
            Text('Choose an item', style: textTheme.labelLarge),
            const SizedBox(height: 10.0),
            Wrap(
              spacing: 5.0,
              children: List<Widget>.generate(3, (int index) {
                return ChoiceChip(
                  label: Text('Item $index'),
                  selected: _value == index,
                  onSelected: (bool selected) {
                    setState(() {
                      _value = selected ? index : null;
                    });
                  },
                );
              }).toList(),
            ),
          ],
        ),
      ),
    );
  }
}

Material Design 3

ChoiceChip can be used for single select Filter chips from Material Design 3. If ThemeData.useMaterial3 is true, then ChoiceChip will be styled to match the Material Design 3 specification for Filter chips. Use FilterChip for multiple select Filter chips.

Constructors

ChoiceChip({Key? key, Widget? avatar, required Widget label, TextStyle? labelStyle, EdgeInsetsGeometry? labelPadding, ValueChanged<bool>? onSelected, double? pressElevation, required bool selected, Color? selectedColor, Color? disabledColor, String? tooltip, BorderSide? side, OutlinedBorder? shape, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, WidgetStateProperty<Color?>? color, Color? backgroundColor, EdgeInsetsGeometry? padding, VisualDensity? visualDensity, MaterialTapTargetSize? materialTapTargetSize, double? elevation, Color? shadowColor, Color? surfaceTintColor, IconThemeData? iconTheme, Color? selectedShadowColor, bool? showCheckmark, Color? checkmarkColor, ShapeBorder avatarBorder = const CircleBorder(), BoxConstraints? avatarBoxConstraints, ChipAnimationStyle? chipAnimationStyle, MouseCursor? mouseCursor}): Create a chip that acts like a radio button.
const
ChoiceChip.elevated({Key? key, Widget? avatar, required Widget label, TextStyle? labelStyle, EdgeInsetsGeometry? labelPadding, ValueChanged<bool>? onSelected, double? pressElevation, required bool selected, Color? selectedColor, Color? disabledColor, String? tooltip, BorderSide? side, OutlinedBorder? shape, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, WidgetStateProperty<Color?>? color, Color? backgroundColor, EdgeInsetsGeometry? padding, VisualDensity? visualDensity, MaterialTapTargetSize? materialTapTargetSize, double? elevation, Color? shadowColor, Color? surfaceTintColor, IconThemeData? iconTheme, Color? selectedShadowColor, bool? showCheckmark, Color? checkmarkColor, ShapeBorder avatarBorder = const CircleBorder(), BoxConstraints? avatarBoxConstraints, ChipAnimationStyle? chipAnimationStyle, MouseCursor? mouseCursor}): Create an elevated chip that acts like a radio button.
const

Properties

autofocus → bool: True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
avatar → Widget?: A widget to display prior to the chip's label.
final
avatarBorder → ShapeBorder: The shape of the translucent highlight painted over the avatar when the selected property is true.
final
avatarBoxConstraints → BoxConstraints?: Optional size constraints for the avatar.
final
backgroundColor → Color?: Color to be used for the unselected, enabled chip's background.
final
checkmarkColor → Color?: Color of the chip's check mark when a check mark is visible.
final
chipAnimationStyle → ChipAnimationStyle?: Used to override the default chip animations durations.
final
clipBehavior → Clip: The content will be clipped (or not) according to this option.
final
color → WidgetStateProperty<Color?>?: The color that fills the chip, in all WidgetStates.
final
disabledColor → Color?: The color used for the chip's background to indicate that it is not enabled.
final
elevation → double?: Elevation to be applied on the chip relative to its parent.
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.
no setterinherited
iconTheme → IconThemeData?: Theme used for all icons in the chip.
final
isEnabled → bool: Whether or not this chip is enabled for input.
no setteroverride
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
label → Widget: The primary content of the chip.
final
labelPadding → EdgeInsetsGeometry?: The padding around the label widget.
final
labelStyle → TextStyle?: The style to be applied to the chip's label.
final
materialTapTargetSize → MaterialTapTargetSize?: Configures the minimum size of the tap target.
final
mouseCursor → MouseCursor?: The cursor for a mouse pointer when it enters or is hovering over the widget.
final
onSelected → ValueChanged<bool>?: Called when the chip should change between selected and de-selected states.
final
padding → EdgeInsetsGeometry?: The padding between the contents of the chip and the outside shape.
final
pressElevation → double?: Elevation to be applied on the chip relative to its parent during the press motion.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selected → bool: Whether or not this chip is selected.
final
selectedColor → Color?: Color to be used for the chip's background, indicating that it is selected.
final
selectedShadowColor → Color?: Color of the chip's shadow when the elevation is greater than 0 and the chip is selected.
final
shadowColor → Color?: Color of the chip's shadow when the elevation is greater than 0.
final
shape → OutlinedBorder?: The OutlinedBorder to draw around the chip.
final
showCheckmark → bool?: Whether or not to show a check mark when SelectableChipAttributes.selected is true.
final
side → BorderSide?: The color and weight of the chip's outline.
final
surfaceTintColor → Color?: Color of the chip's surface tint overlay when its elevation is greater than 0.
final
tooltip → String?: Tooltip string to be used for the body area (where the label and avatar are) of the chip.
final
visualDensity → VisualDensity?: Defines how compact the chip'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.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent 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, int wrapWidth = 65}) → 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.
inherited