--- title: Icon description: "`Icon`は、プロジェクトに使用できる一般的なアイコンコンポーネントです。" 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 ``` ## 使い方 ```tsx import { GhostIcon } from "@yamada-ui/react" ``` ```tsx import { GhostIcon } from "@/components/ui" ``` ```tsx import { GhostIcon } from "@workspaces/ui" ``` ```tsx ``` [こちら](https://yamada-ui.com/icons.md)から提供しているすべてのアイコンを探すことができます。 ### React Iconsを使う [React Icons](https://react-icons.github.io/react-icons)を使う場合は、`as`にコンポーネントをセットします。 ```ts import { Icon } from "@yamada-ui/react" import { FaRobot } from "react-icons/fa" ``` ```tsx ``` ### Lucide labを使う [Lucide lab](https://github.com/lucide-icons/lucide-lab)のアイコンを使う場合は、`LucideIcon`を使用します。 ```ts import { LucideIcon } from "@yamada-ui/react" ``` ```tsx ``` ## 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). | ## アクセシビリティ 現在、v2の移行に伴い、このセクションは更新中です。