Chip

Chips are compact elements that represent an input, attribute, or action.

Usage

Import the component:

import 'mdui/components/chip.js';

Import the TypeScript type:

import type { Chip } from 'mdui/components/chip.js';

Example:

Chip
<mdui-chip>Chip</mdui-chip>

Examples

Variant

The variant attribute determines the chip's appearance. There are four available variants:

  • assist: Represents smart or automated actions that can span multiple apps.
  • filter: Represents filters for a collection.
  • input: Represents discrete pieces of information entered by a user.
  • suggestion: Helps narrow a user’s intent by presenting dynamically generated suggestions.

Elevated

Add the elevated attribute to raise the chip, providing it with a shadow.

Icons

Use the icon and end-icon attributes to add Material Icons to the left and right sides of the chip, respectively. Alternatively, use the icon and end-icon slots to add elements to the chip's sides.

Use the href attribute to transform the chip into a link. The download, target, and rel attributes are available for link-related functionality.

Disabled and Loading States

Use the disabled attribute to disable the chip. The loading attribute displays the loading state.

Selectable

Add the selectable attribute to make the chip selectable.

Use the selected-icon attribute to specify the Material Icons name for the selected state. Alternatively, use the selected-icon slot to specify the selected state icon element.

The selected property is true when the chip is selected. Add the selected attribute to set the chip as selected by default.

Deletable

Add the deletable attribute to add a delete icon to the right of the chip. Clicking this icon triggers the delete event. Use the delete-icon attribute to specify the Material Icons for the delete icon, or use the delete-icon slot to specify the element for the delete icon.

API

Properties

AttributePropertyReflectTypeDefault
variantvariant'assist' | 'filter' | 'input' | 'suggestion''assist'

Defines the chip type. Possible values:

  • assist: Displays auxiliary actions related to the context, such as sharing and favoriting on a meal ordering page.
  • filter: Filters content, like search results on a search results page.
  • input: Represents fragments of user input, such as contacts in the 'To' field in Gmail.
  • suggestion: Provides dynamically generated suggestions to simplify user actions, like message predictions in a chat application.
elevatedelevatedbooleanfalse

Gives the chip a shadow.

selectableselectablebooleanfalse

Makes the chip selectable.

selectedselectedbooleanfalse

Marks the chip as selected.

deletabledeletablebooleanfalse

Makes the chip deletable. When set, a delete icon appears on the right.

iconiconstring-

Sets the Material Icons name for the left icon. Alternatively, use slot="icon".

selected-iconselectedIconstring-

Sets the Material Icons name for the left icon when selected. Alternatively, use slot="selected-icon".

end-iconendIconstring-

Sets the Material Icons name for the right icon. Alternatively, use slot="end-icon".

delete-icondeleteIconstring-

Sets the Material Icons name for the delete icon when deletable. Alternatively, use slot="delete-icon".

hrefhrefstring-

The URL for the hyperlink. If provided, the component is rendered as an <a> element and can use link-related attributes.

downloaddownloadstring-

Instructs the browser to download the linked URL.

Note: This is only available when href is specified.

targettarget'_blank' | '_parent' | '_self' | '_top'-

Defines where to open the linked URL. Possible values:

  • _blank: Opens in a new tab or window.
  • _parent: Opens in the parent browsing context or _self if no parent.
  • _self: Opens in the current browsing context. (Default).
  • _top: Opens in the topmost browsing context or _self if no ancestors.

Note: This is only available when href is specified.

relrel'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag'-

Specifies the relationship of the linked URL as space-separated link types. Possible values:

  • alternate: Alternate versions of the current document.
  • author: The author of the current document or article.
  • bookmark: The permalink for the nearest ancestor section.
  • external: The referenced document is not part of the same site as the current document.
  • help: A link to context-sensitive help.
  • license: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
  • me: Indicates that the current document represents the person who owns the linked content.
  • next: Indicates that the current document is part of a series and the next document in the series is the referenced document.
  • nofollow: Indicates that the current document's original author or publisher does not endorse the referenced document.
  • noreferrer: No Referer header will be included. Also has the same effect as noopener.
  • opener: Creates an auxiliary browsing context if the hyperlink would otherwise create a top-level browsing context that is not an auxiliary browsing context (i.e., has "_blank" as target attribute value).
  • prev: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
  • search: Links to a resource that can be used to search through the current document and its related pages.
  • tag: Gives a tag (identified by the given address) that applies to the current document.

Note: This is only available when href is specified.

autofocusautofocusbooleanfalse

Specifies that the element should be focused when the page loads.

tabindextabIndexnumber-

Defines the order in which the element receives focus when navigating with the Tab key.

disableddisabledbooleanfalse

Disables the element.

loadingloadingbooleanfalse

Indicates that the element is in a loading state.

namenamestring''

The button's name, which is submitted with form data.

Note: This is only available when href is not specified.

valuevaluestring''

The button's value, which is submitted with form data.

Note: This is only available when href is not specified.

typetype'submit' | 'reset' | 'button''button'

Defines the button's default behavior. The default is button. Possible values:

  • submit: Submits the form data to the server.
  • reset: Resets all the controls to their initial values.
  • button: No default behavior, does nothing when pressed by default.

Note: This is only available when href is not specified.

formformstring-

Associates the button with a <form> element. The value should be the id of a <form> in the same document. If not set, the button is associated with its parent <form>, if any.

This attribute allows button elements to be associated with <form>s anywhere in the document, not just inside a <form>.

Note: Only available when href is not specified.

formactionformActionstring-

Specifies the URL that processes the button's submitted information. Overrides the action attribute of the button's form owner.

Note: Only available when href is not specified and type="submit".

formenctypeformEnctype'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'-

Specifies the form data encoding method. Possible values:

  • application/x-www-form-urlencoded: Default if the attribute is not used.
  • multipart/form-data: Used for <input> elements with type set to file.
  • text/plain: For debugging, not for real form submission.

Overrides the enctype attribute of the button's form owner.

Note: Only available when href is not specified and type="submit".

formmethodformMethod'post' | 'get'-

Specifies the HTTP method for form submission. Possible values:

  • post: Form data included in HTTP request body.
  • get: Form data appended to action URL.

Overrides the method attribute of the button's form owner.

Note: Only available when href is not specified and type="submit".

formnovalidateformNoValidatebooleanfalse

Specifies that the form should not be validated on submission. Overrides the novalidate attribute of the button's form owner.

Note: Only available when href is not specified and type="submit".

formtargetformTarget'_self' | '_blank' | '_parent' | '_top'-

Specifies where to display the form submission response. Possible values:

  • _self: Current browsing context. (Default).
  • _blank: New tab or window.
  • _parent: Parent browsing context or _self if no parent.
  • _top: Topmost browsing context or _self if no ancestors.

Overrides the target attribute of the button's form owner.

Note: Only available when href is not specified and type="submit".

validityValidityState-

A ValidityState object that represents the element's validity states.

validationMessagestring-

The element's validation message. This is empty if the element meets its constraints.

Methods

NameParametersReturns
click
void

Simulates a mouse click on the element.

focus
  • options: FocusOptions (Optional)
void

Sets focus on the element. An optional parameter can be an object with a preventScroll property. If preventScroll is set to true, the page will not scroll to bring the focused element into view.

blur
void

Removes focus from the element.

checkValidity
boolean

Checks the validity of the form field. If it's invalid, it triggers an invalid event and returns false. If it's valid, it returns true.

reportValidity
boolean

Checks the validity of the form field. If it's invalid, it triggers an invalid event, returns false, and displays a validation message. If it's valid, it returns true.

setCustomValidity
  • message: string
void

Sets a custom error message. If the text is non-empty, it indicates that the field is invalid.

Events

Name
focus

Emitted when the chip gains focus.

blur

Emitted when the chip loses focus.

invalid

Emitted when the form control's validity is checked and it doesn't meet the constraints.

change

Emitted when the selected state changes.

delete

Emitted when the delete icon is clicked.

Slots

Name
(default)

Text.

icon

Left icon.

end-icon

Right icon.

selected-icon

Left icon when selected.

delete-icon

Delete icon when deletable.

CSS Parts

Name
button

Internal <button> or <a> element.

label

Text.

icon

Left icon.

end-icon

Right icon.

selected-icon

Left icon when selected.

delete-icon

Delete icon on the right.

loading

The <mdui-circular-progress> element for the loading state.

CSS Custom Properties

Name
--shape-corner

The size of the component corner. You can use a specific pixel value, but it's recommended to reference design tokens.

MDUIDocsEnglish简体中文LightDarkSystem
Preset Colors
Custom Color
Extract Color from Wallpaper
Select a Wallpaper
Getting Started
Introduction Installation Usage TypeScript Support IDE Support Localization Frequently Asked Questions
Styles
Dark Theme Dynamic Theme Typography Design Tokens
Frameworks
React Vue Angular
Components
Button ButtonIcon Fab SegmentedButton Chip Card Checkbox Radio Switch Slider RangeSlider List Collapse Tabs Dropdown Menu Select TextField LinearProgress CircularProgress Dialog Divider Avatar Badge Icon Tooltip Snackbar NavigationBar NavigationDrawer NavigationRail BottomAppBar TopAppBar Layout
Functions
JavaScript Library dialog alert confirm prompt snackbar getTheme setTheme getColorFromImage setColorScheme removeColorScheme loadLocale setLocale getLocale throttle observeResize breakpoint
Libraries
@mdui/icons