Radix homepageRadix Homepage
PrimitivesAlpha

Accessible Icon

Makes icons accessible by adding a label.

Features

  • Quickly make any icon accessible by wrapping it and providing a meaningful label.
  • No visual difference, but announced correctly by screen readers.

Install the component from your command line.

npm install @radix-ui/react-accessible-icon

Import the component.

import * as AccessibleIcon from '@radix-ui/react-accessible-icon';
export default () => <AccessibleIcon.Root />;

Contains the icon to make accessible.

PropTypeDefault
label*stringNo default value

Most icons or icon systems come with no accessibility built-in. For example, the same visual cross icon may in fact mean "close" or "delete". This component lets you give meaning to icons used throughout your app.

This is built with Visually Hidden.