A Material Design action chip.

Action chips are a set of options which trigger an action related to primarycontent. Action chips should appear dynamically and contextually in a UI.

Action chips can be tapped to trigger an action or show progress andconfirmation. For Material 3, a disabled state is supported for Actionchips and is specified withonPressed being null. For previous versionsof Material Design, it is recommended to remove the Action chip fromthe interface entirely rather than display a disabled chip.

Action chips are displayed after primary content, such as below a card orpersistently at the bottom of a screen.

The material button widgets,ElevatedButton,TextButton, andOutlinedButton, are an alternative to action chips, which should appearstatically and consistently in a UI.

Requires one of its ancestors to be aMaterial widget.

Material Design 3

ActionChip can be used for both the Assist and Suggestion chips fromMaterial Design 3. IfThemeData.useMaterial3 is true, thenActionChipwill be styled to match the Material Design 3 Assist and Suggestion chips.

Creating an Assist chip

Assist chips are used to provide a quick way to perform an action.To create an Action chip, set the icon property to the iconthat represents the action and set the label to the name of the action.

Creating a Suggestion chip

Suggestion chips usually display generated suggestions for the user,like a suggested response to a message.

To create a Suggestion chip, set the label to the suggestionand don't set the icon property.

See also:

• Chip, a chip that displays information and can be deleted.
• InputChip, a chip that represents a complex piece of information, suchas an entity (person, place, or thing) or conversational text, in acompact form.
• ChoiceChip, allows a single selection from a set of options. Choicechips contain related descriptive text or categories.
• CircleAvatar, which shows images or initials of people.
• Wrap, A widget that displays its children in multiple horizontal orvertical runs.
• material.io/design/components/chips.html

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• ActionChip

Implemented types

• ChipAttributes
• TappableChipAttributes
• DisabledChipAttributes

Constructors

ActionChip({Key?key,Widget?avatar,requiredWidgetlabel,TextStyle?labelStyle,EdgeInsetsGeometry?labelPadding,VoidCallback?onPressed,double?pressElevation,String?tooltip,BorderSide?side,OutlinedBorder?shape,ClipclipBehavior =Clip.none,FocusNode?focusNode,boolautofocus =false,WidgetStateProperty<Color?>?color,Color?backgroundColor,Color?disabledColor,EdgeInsetsGeometry?padding,VisualDensity?visualDensity,MaterialTapTargetSize?materialTapTargetSize,double?elevation,Color?shadowColor,Color?surfaceTintColor,IconThemeData?iconTheme,BoxConstraints?avatarBoxConstraints,ChipAnimationStyle?chipAnimationStyle,MouseCursor?mouseCursor})

Create a chip that acts like a button.

const

ActionChip.elevated({Key?key,Widget?avatar,requiredWidgetlabel,TextStyle?labelStyle,EdgeInsetsGeometry?labelPadding,VoidCallback?onPressed,double?pressElevation,String?tooltip,BorderSide?side,OutlinedBorder?shape,ClipclipBehavior =Clip.none,FocusNode?focusNode,boolautofocus =false,WidgetStateProperty<Color?>?color,Color?backgroundColor,Color?disabledColor,EdgeInsetsGeometry?padding,VisualDensity?visualDensity,MaterialTapTargetSize?materialTapTargetSize,double?elevation,Color?shadowColor,Color?surfaceTintColor,IconThemeData?iconTheme,BoxConstraints?avatarBoxConstraints,ChipAnimationStyle?chipAnimationStyle,MouseCursor?mouseCursor})

Create an elevated chip that acts like a button.

const

Properties

autofocus→bool

True if this widget will be selected as the initial focus when no othernode 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→WidgetStateProperty<Color?>?

The color that fills the chip, in allWidgetStates.

final

disabledColor→Color?

The color used for the chip's background to indicate that it is notenabled.

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 thelabel 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 thewidget.

final

onPressed→VoidCallback?

Called when the user taps the chip.

final

padding→EdgeInsetsGeometry?

The padding between the contents of the chip and the outsideshape.

final

pressElevation→double?

Elevation to be applied on the chip relative to its parent during thepress motion.

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?

TheOutlinedBorder 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 isgreater than 0.

final

tooltip→String?

Tooltip string to be used for the body area (where the label and avatarare) of the chip.

final

visualDensity→VisualDensity?

Defines how compact the chip's layout will be.

final

Methods

build(BuildContextcontext)→Widget

Describes the part of the user interface represented by this widget.

override

createElement()→StatelessElement

Creates aStatelessElement to manage this widget's location in the tree.

inherited

debugDescribeChildren()→List<DiagnosticsNode>

Returns a list ofDiagnosticsNode objects describing this node'schildren.

inherited

debugFillProperties(DiagnosticPropertiesBuilderproperties)→ void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocationinvocation)→ 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 debuggingtools and byDiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevelminLevel =DiagnosticLevel.info})→String

A string representation of this object.

inherited

toStringDeep({StringprefixLineOne ='',String?prefixOtherLines,DiagnosticLevelminLevel =DiagnosticLevel.debug,intwrapWidth =65})→String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({Stringjoiner =', ',DiagnosticLevelminLevel =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 ==(Objectother)→bool

The equality operator.

inherited