@spectrum-web-components/icons

Overview

The and elements included in this package supply your application with the Spectrum CSS medium and large icons for use in the element. Include at least one of these elements in a project that makes use of icons in these sets. You can also include these sets in the scope of any element that leverages them, as they will be deduplicated to ensure all of your components can deliver the icons included therein.

$3


``
yarn add @spectrum-web-components/icons
`

Import the side effectful registration of or via:

`
import '@spectrum-web-components/icons/sp-icons-medium.js';
import '@spectrum-web-components/icons/sp-icons-large.js';
`

When looking to leverage the IconsMedium or IconsLarge base classes as a type and/or for extension purposes, do so via:

`
import { IconsMedium, IconsLarge } from '@spectrum-web-components/icons';
`

$3

The Icons package has been deprecated as part of the removal of the Iconset package from the library and will be removed in an upcoming release. To optimize your build and ensure smaller bundles and higher performance for your users, consider using techniques that include only the icons actually used in your application. For Spectrum icons, you can use UI Icons or Workflow Icons.

For non-Spectrum icons, you can still:

1. Slot SVG or image content into an sp-icon element, or
2. Sanitize the SVG and convert it to a template literal to use within the render() method of an extension of IconBase to create your own custom named icon element.``

$3

Review the accessibility guidelines for the icon.