Vue.js

Appearance

On this page

Chips ​

Types ​

  1. Assist chip
  2. Filter chip
  3. Input chip
  4. Suggestion chip

Usage ​

Choose the type of chip based on its purpose and author.

  • Assist chips are common actions, such as adding an event to a calendar.
  • Filter chips are tags used to filter content, such as shopping categories.
  • Input chips are pieces of information entered by a user, such as event attendees.
  • Suggestion chips represent dynamic suggestions for user input, such as text message replies.
html
<md-chip-set>
  <md-assist-chip label="Assist"></md-assist-chip>
  <md-filter-chip label="Filter"></md-filter-chip>
  <md-input-chip label="Input"></md-input-chip>
  <md-suggestion-chip label="Suggestion"></md-suggestion-chip>
</md-chip-set>

Chip sets ​

Chips should always appear in a set. Chip sets are toolbars that can display any type of chip or other toolbar items.

html
<h3>New event</h3>
<md-chip-set>
  <md-filter-chip label="All day"></md-filter-chip>
  <md-assist-chip label="Add to calendar"></md-assist-chip>
  <md-assist-chip label="Set a reminder"></md-assist-chip>
</md-chip-set>

Icons ​

All chips may display an optional icon. Input chips can specify if an avatar picture is displayed.

html
<md-chip-set>
  <md-assist-chip label="Add to calendar">
    <md-icon slot="icon">event</md-icon>
  </md-assist-chip>

  <md-input-chip label="Ping Qiang" avatar>
    <img slot="icon" src="...">
  </md-input-chip>
</md-chip-set>

Elevated ​

Assist, filter, and suggestion chips can be elevated if the placement requires protection, such as on top of an image.

html
<div>
  <img src="...">
  <md-chip-set>
    <md-suggestion-chip label="Share" elevated></md-suggestion-chip>
    <md-suggestion-chip label="Favorite" elevated></md-suggestion-chip>
  </md-chip-set>
</div>

Accessibility ​

Add an aria-label attribute to chip sets or reference a label with aria-labelledby. Add an aria-label to chips whose labels need to be more descriptive.

html
<h3 id="dates-label">Dates</h3>
<md-chip-set aria-labelledby="dates-label">
  <md-filter-chip label="Mon" aria-label="Monday"></md-filter-chip>
  <md-filter-chip label="Tue" aria-label="Tuesday"></md-filter-chip>
  <md-filter-chip label="Wed" aria-label="Wednesday"></md-filter-chip>
</md-chip-set>

Focusable and disabled ​

By default, disabled chips are not focusable with the keyboard, while "soft-disabled" chips are. Some use cases encourage focusability of disabled toolbar items to increase their discoverability.

See the ARIA guidelines on focusability of disabled controls for guidance on when this is recommended.

html
<md-chip-set aria-label="Actions">
  <!--
    Disabled until text is selected. Since both are disabled by default, keep
    them focusable so that screen readers can discover the actions available.
  -->
  <md-assist-chip label="Copy" soft-disabled></md-assist-chip>
  <md-assist-chip label="Paste" soft-disabled></md-assist-chip>
</md-chip-set>
<md-outlined-text-field type="textarea"></md-outlined-text-field>

Assist chip ​

Assist chips represent smart or automated actions that can span multiple apps, such as opening a calendar event from the home screen.

Assist chips function as though the user asked an assistant to complete the action. They should appear dynamically and contextually in a UI.

html
<h3>A restaraunt location</h3>
<md-chip-set>
  <md-assist-chip label="Add to my itinerary">
    <md-icon slot="icon">calendar</md-icon>
  </md-assist-chip>
  <md-assist-chip label="12 mins from hotel">
    <md-icon slot="icon">map</md-icon>
  </md-assist-chip>
</md-chip-set>

Filter chip ​

Filter chips use tags or descriptive words to filter content. They can be a good alternative to toggle buttons or checkboxes.

html
<h3>Choose where to share</h3>
<md-chip-set>
  <md-filter-chip label="Docs"></md-filter-chip>
  <md-filter-chip label="Slides" selected></md-filter-chip>
  <md-filter-chip label="Sheets" selected></md-filter-chip>
  <md-filter-chip label="Images"></md-filter-chip>
</md-chip-set>

Removable ​

Filter chips can optionally be removable from the chip set. Removable chips have a trailing remove icon.

html
<h3>Colors</h3>
<md-chip-set>
  <md-filter-chip label="Red" removable selected></md-filter-chip>
  <md-filter-chip label="Yellow" removable></md-filter-chip>
  <md-filter-chip label="Blue" removable></md-filter-chip>
  <md-filter-chip label="Green" removable></md-filter-chip>
</md-chip-set>

Input chip ​

Input chips represent discrete pieces of information entered by a user, such as Gmail contacts or filter options within a search field.

Input chips whose icons are user images may add the avatar attribute to display the image in a larger circle.

html
<md-outlined-text-field label="Attendees" type="email"></md-outlined-text-field>

<md-chip-set>
  <md-input-chip label="Ping Qiang" avatar>
    <img slot="icon" src="...">
  </md-input-chip>
  <md-input-chip label="Thea Schröder" avatar>
    <img slot="icon" src="...">
  </md-input-chip>
</md-chip-set>

Remove-only ​

All input chips are removable. If an input chip does not have an action associated with clicking on it, it may be marked as remove-only.

html
<h3>Favorite movies</h3>
<md-chip-set>
  <md-input-chip label="Star Wars" remove-only></md-input-chip>
  <md-input-chip label="Star Trek" remove-only></md-input-chip>
</md-chip-set>

Suggestion chip ​

Suggestion chips help narrow a user’s intent by presenting dynamically generated suggestions, such as possible responses or search filters.

html
<h3>Suggested reply</h3>
<md-chip-set>
  <md-suggestion-chip label="I agree"></md-suggestion-chip>
  <md-suggestion-chip label="Looks good to me"></md-suggestion-chip>
  <md-suggestion-chip label="Thank you"></md-suggestion-chip>
</md-chip-set>

Theming ​

Chips support Material theming and can be customized in terms of color, typography, and shape.

Assist chip tokens ​

TokenDefault value
--md-assist-chip-outline-color--md-sys-color-outline
--md-assist-chip-container-shape--md-sys-shape-corner-small
--md-assist-chip-icon-size18px
--md-assist-chip-label-text-color--md-sys-color-on-surface
--md-assist-chip-label-text-font--md-sys-typescale-label-large-font

Assist chip example ​

html
<style>
:root {
  --md-assist-chip-container-shape: 0px;
  --md-assist-chip-label-text-font: system-ui;
  --md-sys-color-outline: #6F7979;
  --md-sys-color-on-surface: #191C1C;
}
</style>

<md-assist-chip label="Assist"></md-assist-chip>

Filter chip tokens ​

TokenDefault value
--md-filter-chip-selected-container-color--md-sys-color-secondary-container
--md-filter-chip-outline-color--md-sys-color-outline
--md-filter-chip-container-shape--md-sys-shape-corner-small
--md-filter-chip-icon-size18px
--md-filter-chip-label-text-color--md-sys-color-on-surface
--md-filter-chip-label-text-font--md-sys-typescale-label-large-font

Filter chip example ​

html
<style>
:root {
  --md-filter-chip-container-shape: 0px;
  --md-filter-chip-label-text-font: system-ui;
  --md-sys-color-outline: #6f7979;
  --md-sys-color-on-surface: #191c1c;
  --md-sys-color-secondary-container: #cce8e7;
}
</style>

<md-filter-chip label="Filter"></md-filter-chip>

Input chip tokens ​

TokenDefault value
--md-input-chip-outline-color--md-sys-color-outline
--md-input-chip-container-shape--md-sys-shape-corner-small
--md-input-chip-icon-size18px
--md-input-chip-label-text-color--md-sys-color-on-surface
--md-input-chip-label-text-font--md-sys-typescale-label-large-font

Input chip example ​

html
<style>
:root {
  --md-input-chip-container-shape: 0px;
  --md-input-chip-label-text-font: system-ui;
  --md-sys-color-outline: #6f7979;
  --md-sys-color-on-surface: #191c1c;
}
</style>

<md-input-chip label="Input"></md-input-chip>

Suggestion chip tokens ​

TokenDefault value
--md-suggestion-chip-outline-color--md-sys-color-outline
--md-suggestion-chip-container-shape--md-sys-shape-corner-small
--md-suggestion-chip-icon-size18px
--md-suggestion-chip-label-text-color--md-sys-color-on-surface
--md-suggestion-chip-label-text-font--md-sys-typescale-label-large-font

Suggestion chip example ​

html
<style>
:root {
  --md-suggestion-chip-container-shape: 0px;
  --md-suggestion-chip-label-text-font: system-ui;
  --md-sys-color-outline: #6f7979;
  --md-sys-color-on-surface: #191c1c;
}
</style>

<md-suggestion-chip label="Suggestion"></md-suggestion-chip>

API ​

MdChipSet <md-chip-set> ​

Properties ​

PropertyAttributeTypeDefaultDescription
chipsChip[]undefined

MdAssistChip <md-assist-chip> ​

Properties ​

PropertyAttributeTypeDefaultDescription
elevatedelevatedbooleanfalse
hrefhrefstring''
targettargetstring''
disableddisabledbooleanfalseWhether or not the chip is disabled.
Disabled chips are not focusable, unless always-focusable is set.
alwaysFocusablealways-focusablebooleanfalseWhen true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed.
labellabelstring''The label of the chip.
hasIconhas-iconbooleanfalseOnly needed for SSR.
Add this attribute when a chip has a slot="icon" to avoid a Flash Of Unstyled Content.

Events ​

EventTypeBubblesComposedDescription
update-focusEventYesNoDispatched when disabled is toggled.

MdFilterChip <md-filter-chip> ​

Properties ​

PropertyAttributeTypeDefaultDescription
elevatedelevatedbooleanfalse
removableremovablebooleanfalse
selectedselectedbooleanfalse
hasSelectedIconhas-selected-iconbooleanfalseOnly needed for SSR.
Add this attribute when a filter chip has a slot="selected-icon" to avoid a Flash Of Unstyled Content.
disableddisabledbooleanfalseWhether or not the chip is disabled.
Disabled chips are not focusable, unless always-focusable is set.
alwaysFocusablealways-focusablebooleanfalseWhen true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed.
labellabelstring''The label of the chip.
hasIconhas-iconbooleanfalseOnly needed for SSR.
Add this attribute when a chip has a slot="icon" to avoid a Flash Of Unstyled Content.
handleTrailingActionFocus() => voidundefined
ariaLabelRemovestringundefined

Events ​

EventTypeBubblesComposedDescription
removeEventNoNoDispatched when the remove button is clicked.
update-focusEventYesNoDispatched when disabled is toggled.

MdInputChip <md-input-chip> ​

Properties ​

PropertyAttributeTypeDefaultDescription
avataravatarbooleanfalse
hrefhrefstring''
targettargetstring''
removeOnlyremove-onlybooleanfalse
selectedselectedbooleanfalse
disableddisabledbooleanfalseWhether or not the chip is disabled.
Disabled chips are not focusable, unless always-focusable is set.
alwaysFocusablealways-focusablebooleanfalseWhen true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed.
labellabelstring''The label of the chip.
hasIconhas-iconbooleanfalseOnly needed for SSR.
Add this attribute when a chip has a slot="icon" to avoid a Flash Of Unstyled Content.
handleTrailingActionFocus() => voidundefined
ariaLabelRemovestringundefined

Events ​

EventTypeBubblesComposedDescription
removeEventNoNoDispatched when the remove button is clicked.
update-focusEventYesNoDispatched when disabled is toggled.

MdSuggestionChip <md-suggestion-chip> ​

Properties ​

PropertyAttributeTypeDefaultDescription
elevatedelevatedbooleanfalse
hrefhrefstring''
targettargetstring''
disableddisabledbooleanfalseWhether or not the chip is disabled.
Disabled chips are not focusable, unless always-focusable is set.
alwaysFocusablealways-focusablebooleanfalseWhen true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed.
labellabelstring''The label of the chip.
hasIconhas-iconbooleanfalseOnly needed for SSR.
Add this attribute when a chip has a slot="icon" to avoid a Flash Of Unstyled Content.

Events ​

EventTypeBubblesComposedDescription
update-focusEventYesNoDispatched when disabled is toggled.

Edit this page on GitHub