@storybook/design-system/dist/components/Icon.d.ts

Storybook design system

import { FunctionComponent } from 'react';
import { icons } from './shared/icons';
/**
 * An Icon is a piece of visual element, but we must ensure its accessibility while using it.
 * It can have 2 purposes:
 *
 * - *decorative only*: for example, it illustrates a label next to it. We must ensure that it is ignored by screen readers, by setting `aria-hidden` attribute (ex: `<Icon icon="check" aria-hidden />`)
 * - *non-decorative*: it means that it delivers information. For example, an icon as only child in a button. The meaning can be obvious visually, but it must have a proper text alternative via `aria-label` for screen readers. (ex: `<Icon icon="print" aria-label="Print this document" />`)
 */
export declare const Icon: FunctionComponent<IconProps>;
export declare type IconType = keyof typeof icons;
export interface IconProps {
    icon: IconType;
}
//# sourceMappingURL=Icon.d.ts.map