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.

Requires one of its ancestors to be a Material widget. The label and clipBehavior arguments must not be null.

Chip(
  avatar: CircleAvatar(
    backgroundColor: Colors.grey.shade800,
    child: Text('AB'),
  ),
  label: 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.google.com/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, ShapeBorder shape, Clip clipBehavior: Clip.none, Color backgroundColor, EdgeInsetsGeometry padding, MaterialTapTargetSize materialTapTargetSize })
Creates a material design chip. [...]
const

Properties

avatar → Widget
A widget to display prior to the chip's label. [...]
final
backgroundColor → Color
Color to be used for the unselected, enabled chip's background. [...]
final
clipBehavior → Clip
The content will be clipped (or not) according to this option. [...]
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
deleteIconColor → Color
The Color for the delete icon. The default is based on the ambient IconTheme.color.
final
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
shape → ShapeBorder
The ShapeBorder to draw around the chip. [...]
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 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