Icon Ready
Icons are used to provide additional meaning or in places where text label doesn’t fit. Icon component allows you to display an icon from the Nordicons library.
<nord-icon size="xxl" name="navigation-dashboard"></nord-icon>Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
name | name | The name of the icon to display, as defined by nordicons. | string | "" |
size | size | The size of the icon. | "xs" | "s" | "m" | "l" | "xl" | "xxl" | "m" |
color | color | The color of the icon. Can accept any valid CSS color value, including custom properties. | string | undefined | undefined |
label | label | An accessible label for the icon. If no label is supplied, the icon is hidden from assistive technology. | string | undefined | undefined |
Slots
| Slot name | Description |
|---|---|
| Default slot | The default slot used for placing a custom SVG icon. |
Methods
| Method name | Parameters | Description |
|---|---|---|
static registerResolver(resolver: IconResolver) => void | resolver: The resolver function to register. | Register a custom icon resolver, which accepts the icon name as an parameter, and returns an SVG string. Can return a string synchronously, or a promise of a string. By default, will load icons from the Nord CDN. |
static registerIcon(icon: { title: string; default: string }) => void | icon: An object representing the icon to be registered, where "title" is the icon's name, and "default" is the SVG string. This is intended to be used in cases where you import an icon's entire ES module and register it directly. | Register an individual icon so it can be rendered synchronously, to avoid loading over the network. |
static registerIcon(name: string, icon: string) => void | name: The name of the icon to be registered.icon: The SVG string for the icon. | Register an individual icon so it can be rendered synchronously, to avoid loading over the network. |
static registerIcon(iconOrName: string | { title: string; default: string }, icon?: string) => void | iconOrName: The name of the icon to be registered or an object representing the icon to be registered, where "title" is the icon's name, and "default" is the SVG string.icon: The SVG string for the icon. | Register an individual icon so it can be rendered synchronously, to avoid loading over the network. |
Usage #
This section includes guidelines for designers and developers about the usage of this component in different contexts.
Do #
- Use to provide additional meaning in addition to a text label.
- Use to help users who have difficulties with reading and attention.
- Use in places where text label doesn’t fit (remember to add an accessible label for the icon).
Don’t #
- Don’t use for decorative purposes alone.
- Don’t use when a button’s action is already clear based on the text label.
- Don’t use the same icon for differing purposes, as users will come to associate icons with specific types of actions.
Additional considerations #
- Icon components are hidden from assistive technologies by default.
- Use
labelproperty to give an accessible label for the icon and to make it visible to assistive technologies.
Integration
For integration guidelines, please see Web Components documentation. This documentation explains how to implement and use Nord Web Components across different technologies such as Vue.js, React, or Vanilla JavaScript.
Localization
Nord provides a lightweight solution for localizing its components. Not all components need localizing, as for the most part snippets of text are set per instance. For full localization guidelines, please see Localization documentation.
Troubleshooting
If you experience any issues while using Nord Web Components, please head over to the Support page for more guidelines and ways to contact us.