icons-ui

NPM 1.0.1

View Storybook
Overview API Changelog

Overview

Deliver Spectrum UI Icons as either:

  • Registered custom elements (<sp-icon-arrow75>)
  • Unregistered class definitions (IconArrow75)
  • Functions with customizable template tags to be used across various frameworks (Arrow75Icon())

Search a full list of icons to find an icon for your project or find technical information about extended use cases, like consuming this package in various UI frameworks below.

Remember to consult Spectrum's Iconography Guidelines when planning how to leverage these icons in the visual delivery of your application.

Usage

See it on NPM! How big is this package in your project?

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

Import the side effectful registration of a single element (e.g. <sp-icon-arrow75>) via:

import '@spectrum-web-components/icons-ui/icons/sp-icon-arrow75.js';

Leverage a single icon base class (e.g. IconArrow75) as a type, or for extension purposes, do so, via:

import { IconArrow75 } from '@spectrum-web-components/icons-ui/src/elements/IconArrow75.js';

Find an icon

Search the available Spectrum Workflow icons below.

Alternative usage

You can import raw icons (e.g. Arrow75Icon()) via:

import { Arrow75Icon } from '@spectrum-web-components/icons-ui/src/icons/Arrow75.js';

@spectrum-web-components/icons-ui exports all icons. If your build process tree-shakes dependencies, you can import from it directly:

import { Arrow75Icon } from '@spectrum-web-components/icons-ui';

These icon literals are prepared with the html template tag from lit-html, the default value of an icon export will be as follows:

import { LitElement, html } from 'lit-element';
import '@spectrum-web-components/icon';
import { Arrow75Icon } from '@spectrum-web-components/icons-ui';

class ElementWithIcon extends LitElement {
    protected override render(): TemplateResult {
        return html`
            <sp-icon>
                ${Arrow75Icon()}
            </sp-icon>
        `
    }
}

customElements.define('element-with-icon', ElementWithIcon);

Every icons can be customized via the following options:

{
    width: 24, // number outlining the width to deliver the SVG element with
    height: 24, // number outlining the height to delivery the SVG element with
    hidden: false, // boolean representing whether to apply the `aria-hidden` attribute
    title: 'Icon title', // string of the title to deliver the icon with
}

Extended use cases

The default exports of this package are pre-wrapped via setCustomTemplateLiteralTag in the html template tag from lit-html, and work like the following::

import { Arrow75Icon } from '@spectrum-web-components/icons-ui';

console.log(Arrow75Icon());

/***
TemplateResult {strings: Array[1], values: Array[0], type: "html", processor: DefaultTemplateProcessor, constructor: Object}
***/

When working in the context of other frameworks, it is possible to import the icons with a generic template tag as follows:

import { Arrow75Icon } from '@spectrum-web-components/icons-ui/src/icons.js';

console.log(Arrow75Icon());

/***
<svg
    xmlns="http://www.w3.org/2000/svg"
    viewBox="0 0 36 36"
    role="img"
    fill="currentColor"
    height="24"
    width="24"
    aria-hidden="false"
    aria-label="Circle"
>
    <path
      d="M9.26 4.406L6.528 1.672A.84.84 0 005.34 2.859L6.64 4.16H1.396a.84.84 0 000 1.68H6.64l-1.301 1.3a.84.84 0 001.188 1.188l2.734-2.734a.84.84 0 000-1.188z"
    />
</svg>
***/

What's more, if you're already working with a specific parser in your project, you can assign it as the one to use when delivering the icons in order to be sure that the SVG content is delivered as parsed content to your final template. The means if you were working with Preact via the htm tag as bound to the provided hyperscript function:

import {
    Arrow75Icon,
    setCustomTemplateLiteralTag,
} from '@spectrum-web-components/icons-ui/src/icons.js';
import htm from 'htm';
import { h } from 'preact';

const hPreact = htm.bind(h);

setCustomTemplateLiteralTag(hPreact);

console.log(Arrow75Icon());

/***
VNode {nodeName: "svg", children: Array[1], attributes: Object, key: undefined, constructor: Object}
***/

In this way, the icons exported by @spectrum-web-components/icons-ui can be leveraged in projects powered by the likes of hyperHTML, lighterhtml, lit-html, Preact, React, Vanilla JS, Vue.js, and more!

Accessibility

Review the accessibility guidelines for the icon.

Attributes and Properties

Property Attribute Type Default Description label label string '' size size 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl' | undefined

1.0.1 (2024-11-11)

Bug Fixes

  • icon: remove size300 suffix from chevron and checkmark icons in Spectrum 2 (#4904) (a22f42b)

1.0.0 (2024-10-31)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.49.0 (2024-10-15)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.48.1 (2024-10-01)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.48.0 (2024-09-17)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.47.2 (2024-09-03)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.47.1 (2024-08-27)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.47.0 (2024-08-20)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.46.0 (2024-08-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.45.0 (2024-07-30)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.44.0 (2024-07-15)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.43.0 (2024-06-11)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.42.5 (2024-05-24)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.42.4 (2024-05-14)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.42.3 (2024-05-01)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.42.2 (2024-04-03)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.42.1 (2024-04-02)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.42.0 (2024-03-19)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.41.2 (2024-03-05)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.41.1 (2024-02-22)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.41.0 (2024-02-13)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.40.5 (2024-02-05)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.40.4 (2024-01-29)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.40.3 (2024-01-11)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.40.2 (2023-12-18)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.40.1 (2023-12-05)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.40.0 (2023-11-16)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.39.4 (2023-11-02)

Bug Fixes

  • infield-button: add infield-button package (057b885)

0.39.3 (2023-10-18)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.39.2 (2023-10-13)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.39.1 (2023-10-06)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.39.0 (2023-09-25)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.38.0 (2023-09-05)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.37.0 (2023-08-18)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.36.0 (2023-08-18)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.35.0 (2023-07-31)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.34.0 (2023-07-11)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.33.2 (2023-06-14)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.33.0 (2023-06-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.32.0 (2023-06-01)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.31.0 (2023-05-17)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.30.0 (2023-05-03)

Bug Fixes

  • correct @element jsDoc listing across library (c97a632)
  • icon: clean up docs and types for available size values (c38850d)
  • include default export in the "exports" fields (f32407d)
  • include the "types" entry in package.json files (b432f59)
  • remove "type: "module"" in package.json for node 12 (c9f76e2)
  • update latest Spectrum CSS beta releases (d8d3acc)
  • update to latest spectrum-css packages (a5ca19f)
  • use latest @spectrum-css/* versions (c35eb86)

Features

  • add and use icons-ui package (d9c3ab2)
  • adopt DNA@7 base Spectrum CSS (e08cafd)
  • icons-ui: update spectrum css input (4cb87ff)
  • icons-ui: vend fully registered icon components (915a7b5)
  • leverage "exports" field in package.json (321abd7)
  • shared pkg versions, devmode define warning, registry-conflicts docs (6e49565)
  • update lit-* dependencies, wip (377f3c8)
  • update to Spectrum CSS v3.0.0 (e8b3d8f)
  • use latest exports specification (a7ecf4b)

0.9.12 (2023-04-24)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.11 (2023-04-05)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.10 (2023-03-22)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.9 (2023-03-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.8 (2023-02-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.7 (2023-01-23)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.6 (2023-01-09)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.5 (2022-12-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.4 (2022-11-21)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.3 (2022-11-14)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.2 (2022-10-28)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.1 (2022-10-10)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.9.0 (2022-08-09)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.12 (2022-08-04)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.11 (2022-07-18)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.10 (2022-06-29)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.9 (2022-06-07)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.8 (2022-05-27)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.7 (2022-05-12)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.6 (2022-04-21)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.5 (2022-03-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.4 (2022-03-04)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.3 (2022-02-22)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.2 (2022-01-26)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.1 (2021-12-13)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.8.0 (2021-11-08)

Features

  • update lit-* dependencies, wip (377f3c8)

0.7.1 (2021-11-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.7.0 (2021-11-02)

Features

  • adopt DNA@7 base Spectrum CSS (e08cafd)

0.6.11 (2021-09-20)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.10 (2021-08-24)

Bug Fixes

  • correct @element jsDoc listing across library (c97a632)

0.6.9 (2021-08-03)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.8 (2021-07-22)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.7 (2021-06-16)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.6 (2021-05-12)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.5 (2021-04-09)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.4 (2021-03-29)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.3 (2021-03-22)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.2 (2021-03-22)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.1 (2021-03-05)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.6.0 (2021-03-04)

Features

  • use latest exports specification (a7ecf4b)

0.5.3 (2021-02-11)

Bug Fixes

  • update to latest spectrum-css packages (a5ca19f)

0.5.2 (2021-02-02)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.5.1 (2021-01-28)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.5.0 (2021-01-21)

Bug Fixes

  • icon: clean up docs and types for available size values (c38850d)
  • include the "types" entry in package.json files (b432f59)
  • update latest Spectrum CSS beta releases (d8d3acc)
  • use latest @spectrum-css/* versions (c35eb86)

Features

  • icons-ui: update spectrum css input (4cb87ff)
  • icons-ui: vend fully registered icon components (915a7b5)

0.4.0 (2021-01-13)

Bug Fixes

  • include the "types" entry in package.json files (b432f59)
  • update latest Spectrum CSS beta releases (d8d3acc)
  • use latest @spectrum-css/* versions (c35eb86)

Features

  • icons-ui: update spectrum css input (4cb87ff)
  • icons-ui: vend fully registered icon components (915a7b5)

0.3.3 (2020-10-12)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.3.2 (2020-10-12)

Bug Fixes

  • include default export in the "exports" fields (f32407d)

0.3.1 (2020-09-25)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.3.0 (2020-08-31)

Features

  • update to Spectrum CSS v3.0.0 (e8b3d8f)

0.2.2 (2020-08-19)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.2.1 (2020-07-24)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.2.0 (2020-07-17)

Features

  • leverage "exports" field in package.json (321abd7)

0.1.2 (2020-06-08)

Note: Version bump only for package @spectrum-web-components/icons-ui

0.1.1 (2020-05-08)

Bug Fixes

  • remove "type: "module"" in package.json for node 12 (c9f76e2)

0.1.0 (2020-04-16)

Features

  • add and use icons-ui package (d9c3ab2)