Icon

Icons are small visual indicators from a set of pre-defined glyphs.

Props

optional = ?

Name Type Description
source "cancelSmallMinor" | "searchMinor" | "starHollow" | "starFilled" | "sortMinor" Pre-defined glyph content to display.
accessibilityLabel? string Text describing the icon, to be read to screenreaders.

Guidelines

✅ Do 🛑 Don't
Use Icons to provide visual indicators to your actions, such as sorting and searching Use the same accessibility label for every Icon
Use a unique accessibility label that describes the Icon, so that the merchants device’s screen reader can announce the content

For more guidelines, refer to Polaris' Icon related guidelines.

On this page