choice_chip.dart 7.86 KB
Newer Older
1 2 3 4
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'package:flutter/foundation.dart' show clampDouble;
6 7 8 9
import 'package:flutter/widgets.dart';

import 'chip.dart';
import 'chip_theme.dart';
10
import 'color_scheme.dart';
11
import 'colors.dart';
12
import 'debug.dart';
13
import 'text_theme.dart';
14
import 'theme.dart';
15 16
import 'theme_data.dart';

17
/// A Material Design choice chip.
18 19 20 21 22 23 24
///
/// [ChoiceChip]s 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. The [selected] and
/// [label] arguments must not be null.
///
25 26 27
/// {@tool dartpad}
/// This example shows how to create [ChoiceChip]s with [onSelected]. When the
/// user taps, the chip will be selected.
28
///
29
/// ** See code in examples/api/lib/material/choice_chip/choice_chip.0.dart **
30 31
/// {@end-tool}
///
32 33 34 35 36 37 38
/// ## 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.
///
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/// See also:
///
///  * [Chip], a chip that displays information and can be deleted.
///  * [InputChip], a chip that represents a complex piece of information, such
///    as an entity (person, place, or thing) or conversational text, in a
///    compact form.
///  * [FilterChip], uses tags or descriptive words as a way to filter content.
///  * [ActionChip], represents an action related to primary content.
///  * [CircleAvatar], which shows images or initials of people.
///  * [Wrap], A widget that displays its children in multiple horizontal or
///    vertical runs.
///  * <https://material.io/design/components/chips.html>
class ChoiceChip extends StatelessWidget
    implements
        ChipAttributes,
        SelectableChipAttributes,
        DisabledChipAttributes {
  /// Create a chip that acts like a radio button.
  ///
  /// The [label], [selected], [autofocus], and [clipBehavior] arguments must
  /// not be null. The [pressElevation] and [elevation] must be null or
  /// non-negative. Typically, [pressElevation] is greater than [elevation].
  const ChoiceChip({
62
    super.key,
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
    this.avatar,
    required this.label,
    this.labelStyle,
    this.labelPadding,
    this.onSelected,
    this.pressElevation,
    required this.selected,
    this.selectedColor,
    this.disabledColor,
    this.tooltip,
    this.side,
    this.shape,
    this.clipBehavior = Clip.none,
    this.focusNode,
    this.autofocus = false,
    this.backgroundColor,
    this.padding,
    this.visualDensity,
    this.materialTapTargetSize,
    this.elevation,
    this.shadowColor,
84 85
    this.surfaceTintColor,
    this.iconTheme,
86 87
    this.selectedShadowColor,
    this.avatarBorder = const CircleBorder(),
88
  }) : assert(pressElevation == null || pressElevation >= 0.0),
89
       assert(elevation == null || elevation >= 0.0);
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133

  @override
  final Widget? avatar;
  @override
  final Widget label;
  @override
  final TextStyle? labelStyle;
  @override
  final EdgeInsetsGeometry? labelPadding;
  @override
  final ValueChanged<bool>? onSelected;
  @override
  final double? pressElevation;
  @override
  final bool selected;
  @override
  final Color? disabledColor;
  @override
  final Color? selectedColor;
  @override
  final String? tooltip;
  @override
  final BorderSide? side;
  @override
  final OutlinedBorder? shape;
  @override
  final Clip clipBehavior;
  @override
  final FocusNode? focusNode;
  @override
  final bool autofocus;
  @override
  final Color? backgroundColor;
  @override
  final EdgeInsetsGeometry? padding;
  @override
  final VisualDensity? visualDensity;
  @override
  final MaterialTapTargetSize? materialTapTargetSize;
  @override
  final double? elevation;
  @override
  final Color? shadowColor;
  @override
134 135
  final Color? surfaceTintColor;
  @override
136 137 138
  final Color? selectedShadowColor;
  @override
  final ShapeBorder avatarBorder;
139 140
  @override
  final IconThemeData? iconTheme;
141 142 143 144 145 146 147 148

  @override
  bool get isEnabled => onSelected != null;

  @override
  Widget build(BuildContext context) {
    assert(debugCheckHasMaterial(context));
    final ChipThemeData chipTheme = ChipTheme.of(context);
149
    final ChipThemeData? defaults = Theme.of(context).useMaterial3
150
      ? _ChoiceChipDefaultsM3(context, isEnabled, selected)
151
      : null;
152
    return RawChip(
153
      defaultProperties: defaults,
154 155 156 157 158 159 160
      avatar: avatar,
      label: label,
      labelStyle: labelStyle ?? (selected ? chipTheme.secondaryLabelStyle : null),
      labelPadding: labelPadding,
      onSelected: onSelected,
      pressElevation: pressElevation,
      selected: selected,
161
      showCheckmark: Theme.of(context).useMaterial3,
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
      tooltip: tooltip,
      side: side,
      shape: shape,
      clipBehavior: clipBehavior,
      focusNode: focusNode,
      autofocus: autofocus,
      disabledColor: disabledColor,
      selectedColor: selectedColor ?? chipTheme.secondarySelectedColor,
      backgroundColor: backgroundColor,
      padding: padding,
      visualDensity: visualDensity,
      isEnabled: isEnabled,
      materialTapTargetSize: materialTapTargetSize,
      elevation: elevation,
      shadowColor: shadowColor,
177
      surfaceTintColor: surfaceTintColor,
178 179
      selectedShadowColor: selectedShadowColor,
      avatarBorder: avatarBorder,
180
      iconTheme: iconTheme,
181 182 183
    );
  }
}
184

185
// BEGIN GENERATED TOKEN PROPERTIES - ChoiceChip
186

187 188 189 190
// Do not edit by hand. The code between the "BEGIN GENERATED" and
// "END GENERATED" comments are generated from data in the Material
// Design token database by the script:
//   dev/tools/gen_defaults/bin/gen_defaults.dart.
191

192
// Token database version: v0_162
193

194
class _ChoiceChipDefaultsM3 extends ChipThemeData {
195
  _ChoiceChipDefaultsM3(this.context, this.isEnabled, this.isSelected)
196 197
    : super(
        elevation: 0.0,
198
        shape: const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(8.0))),
199 200 201 202 203 204
        showCheckmark: true,
      );

  final BuildContext context;
  final bool isEnabled;
  final bool isSelected;
205 206
  late final ColorScheme _colors = Theme.of(context).colorScheme;
  late final TextTheme _textTheme = Theme.of(context).textTheme;
207 208

  @override
209
  TextStyle? get labelStyle => _textTheme.labelLarge;
210 211 212 213 214

  @override
  Color? get backgroundColor => null;

  @override
215
  Color? get shadowColor => Colors.transparent;
216 217

  @override
218
  Color? get surfaceTintColor => _colors.surfaceTint;
219 220 221

  @override
  Color? get selectedColor => isEnabled
222 223
    ? _colors.secondaryContainer
    : _colors.onSurface.withOpacity(0.12);
224 225

  @override
226
  Color? get checkmarkColor => _colors.onSecondaryContainer;
227 228 229

  @override
  Color? get disabledColor => isSelected
230
   ? _colors.onSurface.withOpacity(0.12)
231 232 233
   : null;

  @override
234
  Color? get deleteIconColor => _colors.onSecondaryContainer;
235 236 237 238

  @override
  BorderSide? get side => !isSelected
    ? isEnabled
239 240
      ? BorderSide(color: _colors.outline)
      : BorderSide(color: _colors.onSurface.withOpacity(0.12))
241
    : const BorderSide(color: Colors.transparent);
242 243 244 245 246

  @override
  IconThemeData? get iconTheme => IconThemeData(
    color: isEnabled
      ? null
247
      : _colors.onSurface,
248 249 250 251 252 253 254 255 256 257 258 259 260 261
    size: 18.0,
  );

  @override
  EdgeInsetsGeometry? get padding => const EdgeInsets.all(8.0);

  /// The chip at text scale 1 starts with 8px on each side and as text scaling
  /// gets closer to 2 the label padding is linearly interpolated from 8px to 4px.
  /// Once the widget has a text scaling of 2 or higher than the label padding
  /// remains 4px.
  @override
  EdgeInsetsGeometry? get labelPadding => EdgeInsets.lerp(
    const EdgeInsets.symmetric(horizontal: 8.0),
    const EdgeInsets.symmetric(horizontal: 4.0),
262
    clampDouble(MediaQuery.textScaleFactorOf(context) - 1.0, 0.0, 1.0),
263 264 265
  )!;
}

266
// END GENERATED TOKEN PROPERTIES - ChoiceChip