Back to Grafana

Icon

packages/grafana-ui/src/components/Icon/Icon.mdx

13.1.2866 B
Original Source

import { Meta, ArgTypes } from '@storybook/addon-docs/blocks'; import { Icon } from './Icon';

<Meta title="MDX|Icon" component={Icon} />

Icon

Grafana's wrapper component over Font Awesome and Unicons icons

Accessibility

Icon is aria-hidden by default. If your icon has semantic meaning, please provide a title or wrap it in a Tooltip.

Usage with Tooltip

If you decide to use a Tooltip to wrap Icon, you need to set a title or aria-label on the Icon component in order for it to appear in the accessibility tree. Tooltip only provides aria-describedby on interaction.

Changing icon size

By default Icon has width and height of 16px and font-size of 14px. Pass className to control icon's size:

jsx
import { css } from '@emotion/css';

<Icon name="check" />;
<ArgTypes of={Icon} />