---
title: Icon
description: "`Icon` is a general icon component that can be used in your projects."
links:
  - style: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/icon/icon.style.ts
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/icon
  - storybook: https://yamada-ui.github.io/yamada-ui?path=/story/components-icon--basic
---

```tsx
<GhostIcon />
```

## Usage

```tsx
import { GhostIcon } from "@yamada-ui/react"
```

```tsx
import { GhostIcon } from "@/components/ui"
```

```tsx
import { GhostIcon } from "@workspaces/ui"
```

```tsx
<GhostIcon />
```

You can find all the icons we offer at [here](https://yamada-ui.com/icons.md).

### Using React Icons

When using [React Icons](https://react-icons.github.io/react-icons), set the component to `as`.

```ts
import { Icon } from "@yamada-ui/react"
import { FaRobot } from "react-icons/fa"
```

```tsx
<Icon as={FaRobot} />
```

### Using Lucide lab

When using [Lucide lab](https://github.com/lucide-icons/lucide-lab), use `LucideIcon`.

```ts
import { LucideIcon } from "@yamada-ui/react"
```

```tsx
<LucideIcon iconNode={burger} />
```

## Used By Components & Hooks

<UsedBy name="icon" />

## Props

### Icon

| Prop          | Default | Type                                                                                                                      | Description                                |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `as`          | -       | `As`                                                                                                                      | The HTML element to render.                |
| `asChild`     | -       | `boolean`                                                                                                                 | Merges its props onto its immediate child. |
| `css`         | -       | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                            |
| `colorScheme` | -       | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                |

### LucideIcon

| Prop          | Default | Type                                                                                                                      | Description                                                               |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `as`          | -       | `As`                                                                                                                      | The HTML element to render.                                               |
| `asChild`     | -       | `boolean`                                                                                                                 | Merges its props onto its immediate child.                                |
| `css`         | -       | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                                                           |
| `colorScheme` | -       | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                                               |
| `iconNode`    | -       | `IconNode`                                                                                                                | The icon of the [Lucide lab](https://github.com/lucide-icons/lucide-lab). |

## Accessibility

If you set `aria-hidden={false}` and `aria-label` on `Icon` or `LucideIcon`, it will be read by screen readers.

```tsx
<Icon as={FaRobot} aria-hidden={false} aria-label="Robot" />
```

### ARIA Roles and Attributes

| Component            | Roles and Attributes | Usage                                             |
| -------------------- | -------------------- | ------------------------------------------------- |
| `Icon`, `LucideIcon` | `role="img"`         | Indicates that this is an image.                  |
|                      | `aria-hidden`        | Excludes the element from the accessibility tree. |