Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@material/icon-button

Package Overview
Dependencies
Maintainers
15
Versions
1664
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/icon-button

The Material Components for the web icon button component

  • 14.0.0
  • unpublished
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
15
Created
Source

Icon buttons

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.

Using icon buttons

Installation

npm install @material/icon-button

Styles

@use "@material/icon-button/styles";

JavaScript instantiation

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.

Icons

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.

Icon button

<button class="mdc-icon-button material-icons">
  <div class="mdc-icon-button__ripple"></div>
  <span class="mdc-icon-button__focus-ring"></span>
  favorite
</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.

Making icon buttons accessible

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 material-icons">
    <div class="mdc-icon-button__ripple"></div>
    <span class="mdc-icon-button__focus-ring"></span>
    favorite
    <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.

Icon button toggle

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'));

Icon button toggle with SVG

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>

Icon button toggle with an image

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>

Icon button toggle with toggled aria label

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>

API

CSS classes

CSS ClassDescription
mdc-icon-buttonMandatory.
mdc-icon-button__rippleMandatory. Indicates the element which shows the ripple styling.
mdc-icon-button--onThis 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__iconThis class is applied to each icon element for the icon button toggle.
mdc-icon-button__icon--onThis 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-ringRecommended. Indicates the element which shows the high contrast mode focus ring styling.

Sass mixins

To customize an icon button's color and properties, you can use the following mixins.

MixinDescription
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

PropertyValue TypeDescription
onBooleanSets the toggle state to the provided isOn value.

Events

Event NameEvent Data StructureDescription
MDCIconButtonToggle:change{"detail": {"isOn": boolean}}Emits when the icon is toggled.

MDCIconButtonToggleAdapter

Method SignatureDescription
addClass(className: string) => voidAdds a class to the root element.
removeClass(className: string) => voidRemoves a class from the root element.
hasClass(className: string) => booleanDetermines whether the root element has the given CSS class name.
setAttr(name: string, value: string) => voidSets the attribute name to value on the root element.
notifyChange(evtData: {isOn: boolean}) => voidBroadcasts a change notification, passing along the evtData to the environment's event handling system. In our vanilla implementation, Custom Events are used for this.

MDCIconButtonToggleFoundation

Method SignatureDescription
handleClick()Event handler triggered on the click event. It will toggle the icon from on/off and update aria attributes.

Keywords

FAQs

Package last updated on 28 Apr 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc