Chip class
A Material Design chip.
Chips are compact elements that represent an attribute, text, entity, or action.
Supplying a non-null onDeleted callback will cause the chip to include a button for deleting the chip.
Its ancestors must include Material, MediaQuery, Directionality, and MaterialLocalizations. Typically all of these widgets are provided by MaterialApp and Scaffold. The label and clipBehavior arguments must not be null.
link
Chip(
avatar: CircleAvatar(
backgroundColor: Colors.grey.shade800,
child: const Text('AB'),
),
label: const Text('Aaron Burr'),
)
See also:
- 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.
- ChoiceChip, allows a single selection from a set of options. Choice chips contain related descriptive text or categories.
- 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 entities.
- Wrap, A widget that displays its children in multiple horizontal or vertical runs.
- material.io/design/components/chips.html
- Inheritance
- Implemented types
Constructors
-
Chip({Key? key, Widget? avatar, required Widget label, TextStyle? labelStyle, EdgeInsetsGeometry? labelPadding, Widget? deleteIcon, VoidCallback? onDeleted, Color? deleteIconColor, String? deleteButtonTooltipMessage, BorderSide? side, OutlinedBorder? shape, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, MaterialStateProperty<
Color?> ? color, Color? backgroundColor, EdgeInsetsGeometry? padding, VisualDensity? visualDensity, MaterialTapTargetSize? materialTapTargetSize, double? elevation, Color? shadowColor, Color? surfaceTintColor, IconThemeData? iconTheme, BoxConstraints? avatarBoxConstraints, BoxConstraints? deleteIconBoxConstraints, ChipAnimationStyle? chipAnimationStyle}) -
Creates a Material Design chip.
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
- avatarBoxConstraints → BoxConstraints?
-
Optional size constraints for the avatar.
final
- backgroundColor → Color?
-
Color to be used for the unselected, enabled chip's background.
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
→ MaterialStateProperty<
Color?> ? -
The color that fills the chip, in all WidgetStates.
final
- deleteButtonTooltipMessage → String?
-
The message to be used for the chip's delete button tooltip.
final
- deleteIcon → Widget?
-
The icon displayed when onDeleted is set.
final
- deleteIconBoxConstraints → BoxConstraints?
-
Optional size constraints for the delete icon.
final
- deleteIconColor → Color?
-
Used to define the delete icon's color with an IconTheme that
contains the icon.
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
- 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
- onDeleted → VoidCallback?
-
Called when the user taps the deleteIcon to delete the chip.
final
- padding → EdgeInsetsGeometry?
-
The padding between the contents of the chip and the outside shape.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- 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
- 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
- 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