Read the documentation on its replacement, which should be used for any new development.
Icons are used to visually communicate core parts of the product and available actions. They can act as wayfinding tools to help users more easily understand where they are in the product, and common interaction patterns that are available.
Every icon is carefully crafted for a specific size and only available sizes can be used.
The Icon component accepts the five VCC UI foreground colors or an arbitrary CSS color string.
Most interactive icons would use the IconButton component or other existing compositions. If you need a reference to the icon file you can use the getIcon
method exposed on the theme
.
<Clickextend={({ theme }) => ({':hover': {'> img': {content: `url(${theme.getIcon('alert-32', 'action')})`,},},})}>Alert<Icon type="alert-32" /></Click>
Click any icon to copy the required code to your clipboard
By default, Icons will render with a role
of presentation
.
If an icon is rendered standalone with no text context it needs to have a text describing it to screen reader users. Passing a label
prop will render the Icon with an alt
text.
Name | Description | Type | Default Value |
---|---|---|---|
color | string | undefined | primary | |
label | string | undefined | `` | |
loading | "eager" | "lazy" | undefined | n/a | |
type | "30daystrial-40" | "360camera-32" | "360camera-40" | "alarm-16" | "alarm-24" | "alarm-32" | "alarm-40" | "alarm-64" | "avatar-16" | "avatar-24" | "avatar-40" | "award-24" | ... 632 more ... | "wireless-40" | n/a |