Logo

AueraUI

Docs

Components

Components

Icon

Used for displaying an svg icon

Logo

React Icons

It's recommended to use React Icons because it offers a large and versatile icon set.

Custom SVG

You can also use a custom SVG, if you prefer not to use from React Icons library

Dynamic SVG

You can dynamically set the icon based on user interactions or props

Note: Avoid wrapping the icon in a fragment (<>...</> or <FaUser/>) as this may cause the component to break.

API Reference

icon

Type:

ElementType

Accepts a JSX element representing an icon.

Default:

size

Type:

number

Size of the icon, this accepts only `number`

Default:

className

Type:

string

Custom class name for the icon

Default:

onClick

Type:

function

Click event handler

Default:

onMouseEnter

Type:

function

Mouse enter event handler

Default:

onMouseLeave

Type:

function

Mouse leave event handler

Default:

styles

Type:

CSSProperties

Custom styles for the icon

Default:

color

Type:

string

Color of the icon

Default:

title

Type:

string

Title of the icon if any

Default: