This package has been deprecated

Author message:

MWC beta is longer supported. Please upgrade to @material/web

@material/mwc-icon

<mwc-icon>

IMPORTANT: The Material Web Components are a work in progress and subject to major changes until 1.0 release.

Icon displays an icon with a chosen name from the Material Icons font, or from any font that supports ligatures.

Material Design Guidelines: System icons

Demo

Installation

npm install @material/mwc-icon

NOTE: The Material Web Components are distributed as ES2017 JavaScript Modules, and use the Custom Elements API. They are compatible with all modern browsers including Chrome, Firefox, Safari, Edge, and IE11, but an additional tooling step is required to resolve bare module specifiers, as well as transpilation and polyfills for IE11. See here for detailed instructions.

Example usage

Basic

<link href="https://fonts.googleapis.com/css?family=Material+Icons&display=block" rel="stylesheet">

<mwc-icon>shopping_cart</mwc-icon>

<script type="module">
  import '@material/mwc-icon/mwc-icon.js';
</script>

As a link

<a href="index.html">
  <mwc-icon>arrow_back</mwc-icon>
</a>

Styled

<style>
  .fancy {
    color: #03a9f4;
    --mdc-icon-size: 64px;
  }
</style>

<mwc-icon class="fancy">accessible_forward</mwc-icon>

Fonts

Most users should include the following in their application HTML when using icons:

<link href="https://fonts.googleapis.com/css?family=Material+Icons&display=block" rel="stylesheet">

This loads the Material Icons font, which is required to render icons, and is not loaded automatically. If you see plain text instead of an icon, then the most likely cause is that the Material Icons font is not loaded.

To see all icons that are available in the Material Icons font, see Material Icons.

For technical details about the Material Icons font, see the Material Icons Developer Guide.

API

Slots

Name	Description
default	The name of the icon to display (e.g. shopping_cart). See Material Icons for an index of all available icons.

Properties/Attributes

None

Methods

None

Events

None

CSS Custom Properties

Name	Default	Description
--mdc-icon-font	Material Icons	Font that supports ligatures and determines which icons are available (see fonts above).
--mdc-icon-size	24px	Size of the icon.