iconset
NPM 1.0.1
View Storybook
Overview
Extend either the Iconset
or IconsetSVG
exports of this package to supply your application with a custom icon set to power the use of <sp-icon>
elements throughout. Give your new icon set a custom name, and you'll be ready to supply them as <sp-icon name="custom-icons:icon">
across your application.
Usage
yarn add @spectrum-web-components/iconset
import { TemplateResult } from 'lit-element'; import { IconsetSVG } from '@spectrum-web-components/iconset/src/iconset-svg.js'; import { CustomIconSet } from 'your-icon-set.js'; export class IconsLarge extends IconsetSVG { public constructor() { super(); this.name = 'custom-icons'; // default iconset name for these icons } protected renderDefaultContent(): TemplateResult { return CustomIconSet; } }
Deprecated
Iconsets have been deprecated and will be removed from the project in an upcoming version. Using a technique that ensures only the icons actually leveraged in your application are present in your build, like UI Icons (../icons-ui/) or Workflow Icons (../icons-workflow/), will ensure smaller bundles and higher performance for you visitor. For non-Spectrum icons, you can still slot SVG and image content into an sp-icon
elementrender()
method in an extension of IconBase
to create your own named icon element.
Accessibility
Review the accessibility guidelines for the
Changelog
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/iconset
0.49.0 (2024-10-15)
Note: Version bump only for package @spectrum-web-components/iconset
0.48.1 (2024-10-01)
Note: Version bump only for package @spectrum-web-components/iconset
0.48.0 (2024-09-17)
Note: Version bump only for package @spectrum-web-components/iconset
0.47.2 (2024-09-03)
Note: Version bump only for package @spectrum-web-components/iconset
0.47.1 (2024-08-27)
Note: Version bump only for package @spectrum-web-components/iconset
0.47.0 (2024-08-20)
Note: Version bump only for package @spectrum-web-components/iconset
0.46.0 (2024-08-08)
Note: Version bump only for package @spectrum-web-components/iconset
0.45.0 (2024-07-30)
Note: Version bump only for package @spectrum-web-components/iconset
0.44.0 (2024-07-15)
Note: Version bump only for package @spectrum-web-components/iconset
0.43.0 (2024-06-11)
Note: Version bump only for package @spectrum-web-components/iconset
0.42.5 (2024-05-24)
Note: Version bump only for package @spectrum-web-components/iconset
0.42.4 (2024-05-14)
Note: Version bump only for package @spectrum-web-components/iconset
0.42.3 (2024-05-01)
Note: Version bump only for package @spectrum-web-components/iconset
0.42.2 (2024-04-03)
Note: Version bump only for package @spectrum-web-components/iconset
0.42.1 (2024-04-02)
Note: Version bump only for package @spectrum-web-components/iconset
0.42.0 (2024-03-19)
Note: Version bump only for package @spectrum-web-components/iconset
0.41.2 (2024-03-05)
Note: Version bump only for package @spectrum-web-components/iconset
0.41.1 (2024-02-22)
Note: Version bump only for package @spectrum-web-components/iconset
0.41.0 (2024-02-13)
Note: Version bump only for package @spectrum-web-components/iconset
0.40.5 (2024-02-05)
Note: Version bump only for package @spectrum-web-components/iconset
0.40.4 (2024-01-29)
Note: Version bump only for package @spectrum-web-components/iconset
0.40.3 (2024-01-11)
Note: Version bump only for package @spectrum-web-components/iconset
0.40.2 (2023-12-18)
Note: Version bump only for package @spectrum-web-components/iconset
0.40.1 (2023-12-05)
Note: Version bump only for package @spectrum-web-components/iconset
0.40.0 (2023-11-16)
Note: Version bump only for package @spectrum-web-components/iconset
0.39.4 (2023-11-02)
Note: Version bump only for package @spectrum-web-components/iconset
0.39.3 (2023-10-18)
Note: Version bump only for package @spectrum-web-components/iconset
0.39.2 (2023-10-13)
Note: Version bump only for package @spectrum-web-components/iconset
0.39.1 (2023-10-06)
Note: Version bump only for package @spectrum-web-components/iconset
0.39.0 (2023-09-25)
Note: Version bump only for package @spectrum-web-components/iconset
0.38.0 (2023-09-05)
Note: Version bump only for package @spectrum-web-components/iconset
0.37.0 (2023-08-18)
Note: Version bump only for package @spectrum-web-components/iconset
0.36.0 (2023-08-18)
Note: Version bump only for package @spectrum-web-components/iconset
0.35.0 (2023-07-31)
Note: Version bump only for package @spectrum-web-components/iconset
0.34.0 (2023-07-11)
Note: Version bump only for package @spectrum-web-components/iconset
0.33.2 (2023-06-14)
Note: Version bump only for package @spectrum-web-components/iconset
0.33.0 (2023-06-08)
Note: Version bump only for package @spectrum-web-components/iconset
0.32.0 (2023-06-01)
Note: Version bump only for package @spectrum-web-components/iconset
0.31.0 (2023-05-17)
Note: Version bump only for package @spectrum-web-components/iconset
0.30.0 (2023-05-03)
Bug Fixes
- allow "updateComplete" to resolve to a boolean like the LitElement default (
6127946 ) - apply "HelpTextMixin" to form elements (
a952447 ) - ensure browser understandable extensions (
f4e59f7 ) - include "type" in package.json, generate custom-elements.json (
1a8d716 ) - include default export in the "exports" fields (
f32407d ) - include the "types" entry in package.json files (
b432f59 ) - lint away debugger statements (
34a498e ) - manage updated node types (
0517fc1 ) - normalize "event" and "error" argument names (
8d382cd ) - remove ":" based namespacing of events (
d77a843 ) - remove "type: "module"" in package.json for node 12 (
c9f76e2 ) - use icons without "size" values (
3fc7c91 )
Features
- icons-workflow: vend fully registered icon components (
941f3a4 ) - iconset: update spectrum css input (
914150a ) - include all Dev Mode files in side effects (
f70817c ) - leverage "exports" field in package.json (
321abd7 ) - update lit-* dependencies, wip (
377f3c8 ) - use latest exports specification (
a7ecf4b )
Performance Improvements
- use "sideEffects" listing in package.json (
7271614 ) - use imported TypeScript helpers instead of inlining them (
cc2bd0a )
0.7.7 (2023-04-05)
Note: Version bump only for package @spectrum-web-components/iconset
0.7.6 (2023-01-23)
Note: Version bump only for package @spectrum-web-components/iconset
0.7.5 (2023-01-09)
Note: Version bump only for package @spectrum-web-components/iconset
0.7.4 (2022-11-21)
Note: Version bump only for package @spectrum-web-components/iconset
0.7.3 (2022-11-14)
Note: Version bump only for package @spectrum-web-components/iconset
0.7.2 (2022-10-28)
Bug Fixes
- manage updated node types (
0517fc1 )
0.7.1 (2022-10-10)
Note: Version bump only for package @spectrum-web-components/iconset
0.7.0 (2022-08-09)
Features
- include all Dev Mode files in side effects (
f70817c )
0.6.9 (2022-08-04)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.8 (2022-06-29)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.7 (2022-06-07)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.6 (2022-05-12)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.5 (2022-04-21)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.4 (2022-03-08)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.3 (2022-03-04)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.2 (2022-02-22)
Note: Version bump only for package @spectrum-web-components/iconset
0.6.1 (2021-12-13)
Bug Fixes
- apply "HelpTextMixin" to form elements (
a952447 )
0.6.0 (2021-11-08)
Features
- update lit-* dependencies, wip (
377f3c8 )
0.5.8 (2021-11-08)
Bug Fixes
- allow "updateComplete" to resolve to a boolean like the LitElement default (
6127946 )
0.5.7 (2021-07-22)
Note: Version bump only for package @spectrum-web-components/iconset
0.5.6 (2021-06-16)
Bug Fixes
- lint away debugger statements (
34a498e )
0.5.5 (2021-04-09)
Note: Version bump only for package @spectrum-web-components/iconset
0.5.4 (2021-03-29)
Note: Version bump only for package @spectrum-web-components/iconset
0.5.3 (2021-03-22)
Note: Version bump only for package @spectrum-web-components/iconset
0.5.2 (2021-03-22)
Note: Version bump only for package @spectrum-web-components/iconset
0.5.1 (2021-03-05)
Note: Version bump only for package @spectrum-web-components/iconset
0.5.0 (2021-03-04)
Features
- use latest exports specification (
a7ecf4b )
0.4.3 (2021-02-11)
Note: Version bump only for package @spectrum-web-components/iconset
0.4.2 (2021-02-02)
Note: Version bump only for package @spectrum-web-components/iconset
0.4.1 (2021-01-28)
Note: Version bump only for package @spectrum-web-components/iconset
0.4.0 (2021-01-21)
Bug Fixes
- include the "types" entry in package.json files (
b432f59 ) - use icons without "size" values (
3fc7c91 )
Features
- icons-workflow: vend fully registered icon components (
941f3a4 ) - iconset: update spectrum css input (
914150a )
0.3.0 (2021-01-13)
Bug Fixes
- include the "types" entry in package.json files (
b432f59 ) - use icons without "size" values (
3fc7c91 )
Features
- icons-workflow: vend fully registered icon components (
941f3a4 ) - iconset: update spectrum css input (
914150a )
0.2.5 (2020-10-12)
Note: Version bump only for package @spectrum-web-components/iconset
0.2.4 (2020-10-12)
Bug Fixes
- include default export in the "exports" fields (
f32407d )
0.2.3 (2020-09-25)
Note: Version bump only for package @spectrum-web-components/iconset
0.2.2 (2020-08-31)
Note: Version bump only for package @spectrum-web-components/iconset
0.2.1 (2020-08-19)
Bug Fixes
- ensure browser understandable extensions (
f4e59f7 )
0.2.0 (2020-07-17)
Features
- leverage "exports" field in package.json (
321abd7 )
0.1.11 (2020-06-08)
Note: Version bump only for package @spectrum-web-components/iconset
0.1.10 (2020-05-08)
Bug Fixes
- remove "type: "module"" in package.json for node 12 (
c9f76e2 )
0.1.9 (2020-04-16)
Performance Improvements
- use "sideEffects" listing in package.json (
7271614 )
0.1.8 (2020-04-07)
Note: Version bump only for package @spectrum-web-components/iconset
0.1.7 (2019-12-02)
Bug Fixes
- normalize "event" and "error" argument names (
8d382cd )
0.1.6 (2019-11-27)
Bug Fixes
- include "type" in package.json, generate custom-elements.json (
1a8d716 )
0.1.5 (2019-11-01)
Bug Fixes
- remove ":" based namespacing of events (
d77a843 )
0.1.4 (2019-10-14)
Performance Improvements
- use imported TypeScript helpers instead of inlining them (
cc2bd0a )
0.1.3 (2019-10-03)
Note: Version bump only for package @spectrum-web-components/iconset