@material/icon-button
Advanced tools
The Material Components for the web icon button component
Icon buttons allow users to take actions, and make choices, with a single tap.
Note: For buttons with both icons and text, use the mdc-button component. For more information, see the mdc-button docs.
npm install @material/icon-button
@use "@material/icon-button/styles";
The icon button will work without JavaScript, but you can enhance it to have a ripple effect by instantiating MDCRipple on the root element.
See MDC Ripple for details.
import {MDCRipple} from '@material/ripple';
const iconButtonRipple = new MDCRipple(document.querySelector('.mdc-icon-button'));
iconButtonRipple.unbounded = true;
Note: See Importing the JS component for more information on how to import JavaScript.
We recommend using Material Icons from Google Fonts:
<head>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
</head>
However, you can also use SVG, Font Awesome, or any other icon library you wish.
<button class="mdc-icon-button">
<div class="mdc-icon-button__ripple"></div>
<span class="mdc-icon-button__focus-ring"></span>
<i class="material-icons">favorite</i>
</button>
Note: The MDC Icon Button can be used with both <button> and <a> tags.
Note: IE11 will not center the icon properly if there is a newline or space after the material icon text.
Material Design spec advises that touch targets should be at least 48 x 48 px. To meet this requirement, add the following to your button:
<div class="mdc-touch-target-wrapper">
<button class="mdc-icon-button">
<div class="mdc-icon-button__ripple"></div>
<span class="mdc-icon-button__focus-ring"></span>
<i class="material-icons">favorite</i>
<div class="mdc-icon-button__touch"></div>
</button>
</div>
Note: The outer mdc-touch-target-wrapper element is only necessary if you want to avoid potentially overlapping touch targets on adjacent elements (due to collapsing margins).
The mdc-icon-button__focus-ring element ensures that a focus indicator is displayed in high contrast mode around the active/focused icon button.
The icon button can be used to toggle between an on and off icon.
To style an icon button as an icon button toggle, add
both icons as child elements and place the mdc-icon-button__icon--on class on the icon that represents the on element.
If the button should be initialized in the "on" state, then add the mdc-icon-button--on class to the parent button.
<button id="add-to-favorites"
class="mdc-icon-button"
aria-label="Add to favorites"
aria-pressed="false">
<div class="mdc-icon-button__ripple"></div>
<span class="mdc-icon-button__focus-ring"></span>
<i class="material-icons mdc-icon-button__icon mdc-icon-button__icon--on">favorite</i>
<i class="material-icons mdc-icon-button__icon">favorite_border</i>
</button>
Then, instantiate an MDCIconButtonToggle on the root element.
import {MDCIconButtonToggle} from '@material/icon-button';
const iconToggle = new MDCIconButtonToggle(document.querySelector('.mdc-icon-button'));
The icon button toggle can be used with SVGs.
<button id="star-this-item"
class="mdc-icon-button mdc-icon-button--on"
aria-label="Unstar this item"
aria-pressed="true">
<div class="mdc-icon-button__ripple"></div>
<span class="mdc-icon-button__focus-ring"></span>
<svg class="mdc-icon-button__icon">
...
</svg>
<svg class="mdc-icon-button__icon mdc-icon-button__icon--on">
...
</svg>
</button>
The icon button toggle can be used with img tags.
<button id="star-this-item"
class="mdc-icon-button mdc-icon-button--on"
aria-label="Unstar this item"
aria-pressed="true">
<div class="mdc-icon-button__ripple"></div>
<span class="mdc-icon-button__focus-ring"></span>
<img src="" class="mdc-icon-button__icon"/>
<img src="" class="mdc-icon-button__icon mdc-icon-button__icon--on"/>
</button>
Some designs may call for the aria label to change depending on the icon button
state. In this case, specify the data-aria-label-on (aria label in on state)
and aria-data-label-off (aria label in off state) attributes, and omit the
aria-pressed attribute.
<button id="add-to-favorites"
class="mdc-icon-button"
aria-label="Add to favorites"
data-aria-label-on="Remove from favorites"
data-aria-label-off="Add to favorites">
<div class="mdc-icon-button__ripple"></div>
<span class="mdc-icon-button__focus-ring"></span>
<i class="material-icons mdc-icon-button__icon mdc-icon-button__icon--on">favorite</i>
<i class="material-icons mdc-icon-button__icon">favorite_border</i>
</button>
| CSS Class | Description |
|---|---|
mdc-icon-button | Mandatory. |
mdc-icon-button__ripple | Mandatory. Indicates the element which shows the ripple styling. |
mdc-icon-button--on | This class is applied to the root element and is used to indicate if the icon button toggle is in the "on" state. |
mdc-icon-button__icon | This class is applied to each icon element for the icon button toggle. |
mdc-icon-button__icon--on | This class is applied to a icon element and is used to indicate the toggle button icon that is represents the "on" icon. |
mdc-icon-button__focus-ring | Recommended. Indicates the element which shows the high contrast mode focus ring styling. |
To customize an icon button's color and properties, you can use the following mixins.
| Mixin | Description |
|---|---|
density($density-scale) | Sets density scale for icon button. Supported density scales range from -5 to 0, (0 being the default). |
size($size) | Sets the padding for the icon button based on overall size. |
ink-color($color) | Sets the font color and the ripple color to the provided color value. |
disabled-ink-color($color) | Sets the font color to the provided color value for a disabled icon button. |
flip-icon-in-rtl() | Flips icon only in RTL context. |
MDCIconButtonToggle properties and methods| Property | Value Type | Description |
|---|---|---|
on | Boolean | Sets the toggle state to the provided isOn value. |
| Event Name | Event Data Structure | Description |
|---|---|---|
MDCIconButtonToggle:change | {"detail": {"isOn": boolean}} | Emits when the icon is toggled. |
MDCIconButtonToggleAdapter| Method Signature | Description |
|---|---|
addClass(className: string) => void | Adds a class to the root element. |
removeClass(className: string) => void | Removes a class from the root element. |
hasClass(className: string) => boolean | Determines whether the root element has the given CSS class name. |
setAttr(name: string, value: string) => void | Sets the attribute name to value on the root element. |
notifyChange(eventData: {isOn: boolean}) => void | Broadcasts a change notification, passing along the eventData to the environment's event handling system. In our vanilla implementation, Custom Events are used for this. |
MDCIconButtonToggleFoundation| Method Signature | Description |
|---|---|
handleClick() | Event handler triggered on the click event. It will toggle the icon from on/off and update aria attributes. |
FAQs
The Material Components for the web icon button component
The npm package @material/icon-button receives a total of 567,504 weekly downloads. As such, @material/icon-button popularity was classified as popular.
We found that @material/icon-button demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.