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>

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.

Icon

End Icon

Slot

<mdui-chip icon="search">Icon</mdui-chip>
<mdui-chip end-icon="arrow_forward">End Icon</mdui-chip>
<mdui-chip>
  Slot
  <mdui-icon slot="icon" name="downloading"></mdui-icon>
  <mdui-icon slot="end-icon" name="attach_file"></mdui-icon>
</mdui-chip>

Source

Link

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

Link

<mdui-chip href="https://www.mdui.org" target="_blank">Link</mdui-chip>

Source

Disabled and Loading States

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

Disabled

Loading & Disabled

<mdui-chip disabled>Disabled</mdui-chip>
<mdui-chip loading>Loading</mdui-chip>
<mdui-chip loading disabled>Loading & Disabled</mdui-chip>

Source

Selectable

Add the selectable attribute to make the chip selectable.

Chip

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

Source

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

Chip

<mdui-chip selectable selected-icon="favorite">Chip</mdui-chip>
<mdui-chip selectable>
  Chip
  <mdui-icon slot="selected-icon" name="favorite"></mdui-icon>
</mdui-chip>

Source

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

Chip

<mdui-chip selectable selected>Chip</mdui-chip>

Source

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 Icon for the delete icon, or use the delete-icon slot to specify the element for the delete icon.

Chip

<mdui-chip deletable>Chip</mdui-chip>
<mdui-chip deletable delete-icon="backspace">Chip</mdui-chip>
<mdui-chip deletable>
  Chip
  <mdui-icon slot="delete-icon" name="backspace"></mdui-icon>
</mdui-chip>

Source

API

Properties

Attribute	Property	Type	Default
`variant`	`variant`	`'assist' \| 'filter' \| 'input' \| 'suggestion'`	`'assist'`
Defines the chip variant. Possible values: `assist`: Shows contextual actions, such as sharing or favoriting on a meal-ordering page. `filter`: Filters content, such as search results. `input`: Represents user input, such as contacts in Gmail's 'To' field. `suggestion`: Shows dynamic suggestions that help users act more quickly, such as message suggestions in a chat app.
`elevated`	`elevated`	`boolean`	`false`
Adds a shadow to the chip.
`selectable`	`selectable`	`boolean`	`false`
Makes the chip selectable.
`selected`	`selected`	`boolean`	`false`
Marks the chip as selected.
`deletable`	`deletable`	`boolean`	`false`
Makes the chip deletable. If set, a delete icon appears on the right.
`icon`	`icon`	`string`	-
Sets the Material Icons name for the left icon. Alternatively, use `slot="icon"`.
`selected-icon`	`selectedIcon`	`string`	-
Sets the Material Icons name for the left icon when selected. Alternatively, use `slot="selected-icon"`.
`end-icon`	`endIcon`	`string`	-
Sets the Material Icons name for the right icon. Alternatively, use `slot="end-icon"`.
`delete-icon`	`deleteIcon`	`string`	-
Sets the Material Icons name for the delete icon when deletable. Alternatively, use `slot="delete-icon"`.
`href`	`href`	`string`	-
The URL for the link. When set, the component renders as an `<a>` element and supports link-related attributes.
`download`	`download`	`string`	-
Downloads the linked URL. Note: Only available when `href` is specified.
`target`	`target`	`'_blank' \| '_parent' \| '_self' \| '_top'`	-
Controls where the linked URL opens. Possible values: `_blank`: Opens in a new tab or window. `_parent`: Opens in the parent browsing context, or `_self` if there is no parent. `_self`: Opens in the current browsing context (default). `_top`: Opens in the topmost browsing context, or `_self` if there are no ancestors. Note: Only available when `href` is specified.
`rel`	`rel`	`'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`: An alternate version 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`: Content covered by the copyright license described by the referenced document. `me`: Links to content owned by the current document's author. `next`: The next document in the series. `nofollow`: Not endorsed by the original author or publisher. `noreferrer`: Prevents the `Referer` header from being sent. 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 one (i.e., when `target="_blank"`). `prev`: The previous document in the series. `search`: Links to a resource that can be used to search through the current document and its related pages. `tag`: Marks the current document with the given tag. Note: Only available when `href` is specified.
`autofocus`	`autofocus`	`boolean`	`false`
Whether the element is focused when the page loads.
`tabindex`	`tabIndex`	`number`	-
The element's tab order when navigating with the Tab key.
`disabled`	`disabled`	`boolean`	`false`
Disables the element.
`loading`	`loading`	`boolean`	`false`
Indicates that the element is in a loading state.
`name`	`name`	`string`	`''`
The button name submitted with form data. Note: Only available when `href` is not specified.
`value`	`value`	`string`	`''`
The button value submitted with form data. Note: Only available when `href` is not specified.
`type`	`type`	`'submit' \| 'reset' \| 'button'`	`'button'`
Specifies the button's default action. Default: `button`. Possible values: `submit`: Submits the form data to the server. `reset`: Restores all controls to their initial values. `button`: Does nothing by default. Note: Only available when `href` is not specified.
`form`	`form`	`string`	-
Associates the button with a `<form>` element. Set this to the `id` of a `<form>` in the same document. If omitted, the button uses its parent `<form>`, if any. This lets the button target any form in the document, not just the one it is nested in. Note: Only available when `href` is not specified.
`formaction`	`formAction`	`string`	-
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"`.
`formenctype`	`formEnctype`	`'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'`	-
Specifies how to encode the form data. Possible values: `application/x-www-form-urlencoded`: Default when the attribute is omitted. `multipart/form-data`: Used for `<input>` elements with `type="file"`. `text/plain`: Useful for debugging, but not for actual form submissions. Overrides the `enctype` attribute of the button's form owner. Note: Only available when `href` is not specified and `type="submit"`.
`formmethod`	`formMethod`	`'post' \| 'get'`	-
Specifies the HTTP method for form submission. Possible values: `post`: Sends the form data in the request body. `get`: Appends the form data to the `action` URL. Overrides the `method` attribute of the button's form owner. Note: Only available when `href` is not specified and `type="submit"`.
`formnovalidate`	`formNoValidate`	`boolean`	`false`
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"`.
`formtarget`	`formTarget`	`'_self' \| '_blank' \| '_parent' \| '_top'`	-
Specifies where to open the response after form submission. Possible values: `_self`: Current browsing context (default). `_blank`: New tab or window. `_parent`: Parent browsing context, or `_self` if there is no parent. `_top`: Topmost browsing context, or `_self` if there are no ancestors. Overrides the `target` attribute of the button's form owner. Note: Only available when `href` is not specified and `type="submit"`.
	`validity`	`ValidityState`	-
A `ValidityState` object that represents the element's validity states.
	`validationMessage`	`string`	-
The validation message. Returns an empty string when the element is valid.

Methods

Name	Parameters	Returns
`click`		`void`
Simulates a mouse click on the element.
`focus`	`options: FocusOptions` (Optional)	`void`
Sets focus on the element. An optional object parameter may include 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 is invalid, it triggers an `invalid` event and returns `false`. If valid, it returns `true`.
`reportValidity`		`boolean`
Checks the validity of the form field. If it is invalid, it triggers an `invalid` event, returns `false`, and displays a validation message. If valid, it returns `true`.
`setCustomValidity`	`message: string`	`void`
Sets a custom error message. If the message is non-empty, the field is considered 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 does not 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 corner radius of the component. You can use a specific pixel value, but it is recommended to reference design tokens.

Checkbox

CircularProgress

Chip

Usage

Examples

Variant

Elevated

Icons

Link

Disabled and Loading States

Selectable

Deletable

API

Properties

Methods

Events

Slots

CSS Parts

CSS Custom Properties