---
title: IconButton
description: "`IconButton` is a component that displays an icon within a button."
links:
  - style: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/icon-button/icon-button.style.ts
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/icon-button
  - storybook: https://yamada-ui.github.io/yamada-ui?path=/story/components-iconbutton--basic
---

```tsx
<IconButton aria-label="Plus" icon={<PlusIcon />} />
```

## Usage

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

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

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

```tsx
<IconButton />
```

### Change Variant

```tsx
<Wrap gap="md">
  <For each={["solid", "subtle", "surface", "outline", "ghost"]}>
    {(variant, index) => (
      <IconButton
        key={index}
        variant={variant}
        aria-label="Plus"
        icon={<PlusIcon />}
      />
    )}
  </For>
</Wrap>
```

### Change Size

```tsx
<Wrap gap="md" alignItems="flex-start">
  <For each={["xs", "sm", "md", "lg", "xl"]}>
    {(size, index) => (
      <IconButton
        key={index}
        size={size}
        aria-label="Plus"
        icon={<PlusIcon />}
      />
    )}
  </For>
</Wrap>
```

### Change Color Scheme

```tsx
<Wrap gap="md">
  <For each={["success", "warning"]}>
    {(colorScheme, index) => (
      <IconButton
        key={index}
        colorScheme={colorScheme}
        aria-label="Plus"
        icon={<PlusIcon />}
      />
    )}
  </For>
</Wrap>
```

### Change Shape

To rounded corners, set `fullRounded` to `true`.

```tsx
<Wrap gap="md">
  <IconButton
    variant="solid"
    aria-label="Plus"
    fullRounded
    icon={<PlusIcon />}
  />

  <IconButton
    variant="subtle"
    aria-label="Minus"
    fullRounded
    icon={<MinusIcon />}
  />

  <IconButton
    variant="surface"
    aria-label="Bold"
    fullRounded
    icon={<BoldIcon />}
  />

  <IconButton
    variant="outline"
    aria-label="Light"
    fullRounded
    icon={<SunIcon />}
  />

  <IconButton
    variant="ghost"
    aria-label="Dark"
    fullRounded
    icon={<MoonIcon />}
  />
</Wrap>
```

### Disable

To disable, set `disabled` to `true`.

```tsx
<Wrap gap="md">
  <IconButton variant="solid" aria-label="Plus" disabled icon={<PlusIcon />} />

  <IconButton
    variant="subtle"
    aria-label="Minus"
    disabled
    icon={<MinusIcon />}
  />

  <IconButton
    variant="surface"
    aria-label="Bold"
    disabled
    icon={<BoldIcon />}
  />

  <IconButton
    variant="outline"
    aria-label="Light"
    disabled
    icon={<SunIcon />}
  />

  <IconButton variant="ghost" aria-label="Dark" disabled icon={<MoonIcon />} />
</Wrap>
```

## Props

| 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.                                           |
| `size`          | `"md"`     | `"2xl" \| "2xs" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"`                                                                  | The size of the component.                                            |
| `variant`       | `"solid"`  | `"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...`                                                            | The variant of the component.                                         |
| `active`        | `false`    | `boolean`                                                                                                                 | If `true`, the button is represented as active.                       |
| `disabled`      | `false`    | `boolean`                                                                                                                 | If `true`, the button is disabled.                                    |
| `disableRipple` | `false`    | `boolean`                                                                                                                 | If `true`, disable ripple effects when pressing a element.            |
| `fullRounded`   | `false`    | `boolean`                                                                                                                 | If `true`, the button is full rounded. Else, it'll be slightly round. |
| `icon`          | -          | `ReactNode`                                                                                                               | The icon to be used in the button.                                    |
| `loading`       | `false`    | `boolean`                                                                                                                 | If `true`, the loading state of the button is represented.            |
| `type`          | `"button"` | `"button" \| "reset" \| "submit"`                                                                                         | The type of button. Accepts `button`, `reset`, or `submit`.           |

## Accessibility

Currently, this section is being updated due to the migration of v2.