Skip to main content

Icon

Simple icon component that is a wrapper for the icons in the availity uikit. Icon List

Version

Installation

npm

npm install @availity/icon --save

Yarn

yarn add @availity/icon

Example

import React from 'react';
import Icon from '@availity/icon';

const Example = () => <Icon name="home" size="3x" color="primary" />;

Live example

Storybook

All icons that are passed on onClick function will have a style of {cursor: 'pointer'} on hover.

Props

name: string

The name of the icon. Icon List

size?: string

The size of the icon. Potential values: "lg", "xl", "2x", "3x", "4x", "5x"

color?: string

The text color of the icon. Uses Availity UI Kit variants.

aria-label?: string

See: aria-label. Default: name