ButtonIcon

Icon buttons are used to execute minor actions with a single click.

Usage

Import the component:

import 'mdui/components/button-icon.js';

Import the TypeScript type:

import type { ButtonIcon } from 'mdui/components/button-icon.js';

Example:

<mdui-button-icon icon="search"></mdui-button-icon>

Examples

Icon

Use the icon attribute to specify the Material Icons name. Alternatively, you can use the default slot to specify the icon element.

<mdui-button-icon icon="search"></mdui-button-icon>
<mdui-button-icon>
  <mdui-icon name="search"></mdui-icon>
</mdui-button-icon>

Code

Shape

The variant attribute determines the shape of the icon button.

<mdui-button-icon variant="standard" icon="search"></mdui-button-icon>
<mdui-button-icon variant="filled" icon="search"></mdui-button-icon>
<mdui-button-icon variant="tonal" icon="search"></mdui-button-icon>
<mdui-button-icon variant="outlined" icon="search"></mdui-button-icon>

Code

Selectable

Add the selectable attribute to make the icon button selectable.

<mdui-button-icon selectable icon="favorite_border"></mdui-button-icon>

Code

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.

<mdui-button-icon selectable icon="favorite_border" selected-icon="favorite"></mdui-button-icon>
<mdui-button-icon selectable icon="favorite_border">
  <mdui-icon slot="selected-icon" name="favorite"></mdui-icon>
</mdui-button-icon>

Code

The selected property is true when the icon button is selected. Add the selected attribute to set the icon button to the selected state by default.

<mdui-button-icon selectable selected icon="favorite_border" selected-icon="favorite"></mdui-button-icon>

Code

Link

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

<mdui-button-icon icon="search" href="https://www.mdui.org" target="_blank"></mdui-button-icon>

Code

Disabled and Loading State

Use the disabled attribute to disable the icon button. The loading attribute displays the loading state.

<mdui-button-icon disabled icon="search" variant="tonal"></mdui-button-icon>
<mdui-button-icon loading icon="search" variant="tonal"></mdui-button-icon>
<mdui-button-icon loading disabled icon="search" variant="tonal"></mdui-button-icon>

Code

API

Properties

Attribute	Property	Type	Default
`variant`	`variant`	`'standard' \| 'filled' \| 'tonal' \| 'outlined'`	`'standard'`
Defines the icon button style. Possible values: `standard`: For low-priority actions. `filled`: Has the strongest visual effect, suitable for high-priority actions. `tonal`: A visual effect between `filled` and `outlined`, suitable for medium to high-priority actions. `outlined`: For medium-priority actions.
`icon`	`icon`	`string`	-
Specifies the Material Icons name. Alternatively, use the default slot.
`selected-icon`	`selectedIcon`	`string`	-
Specifies the Material Icons name when selected. Alternatively, use `slot="selected-icon"`.
`selectable`	`selectable`	`boolean`	`false`
Indicates if the button is selectable.
`selected`	`selected`	`boolean`	`false`
Indicates if the button is selected.
`href`	`href`	`string`	-
The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.
`download`	`download`	`string`	-
Instructs the browser to download the linked URL. Note: This is only available when `href` is specified.
`target`	`target`	`'_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.
`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`: 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.
`autofocus`	`autofocus`	`boolean`	`false`
Specifies that the element should be focused when the page loads.
`tabindex`	`tabIndex`	`number`	-
Defines the order in which the element receives focus 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's name, which is submitted with form data. Note: This is only available when `href` is not specified.
`value`	`value`	`string`	`''`
The button's value, which is submitted with form data. Note: This is only available when `href` is not specified.
`type`	`type`	`'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.
`form`	`form`	`string`	-
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.
`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 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"`.
`formmethod`	`formMethod`	`'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"`.
`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 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"`.
	`validity`	`ValidityState`	-
A `ValidityState` object that represents the element's validity states.
	`validationMessage`	`string`	-
The element's validation message. This is empty if the element meets its constraints.

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 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 button gains focus.
`blur`
Emitted when the button loses focus.
`change`
Emitted when the selected state changes.
`invalid`
Emitted when the form control's validity is checked and it doesn't meet the constraints.

Slots

Name
(default)
Icon component.
`selected-icon`
Icon in the selected state.

CSS Parts

Name
`button`
Internal `<button>` or `<a>` element.
`icon`
Icon.
`selected-icon`
Icon in the selected state.
`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.

Button

Up Next

Fab