---
title: Input
description: "`Input` is a component used to obtain text input from the user."
links:
  - style: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/input/input.style.ts
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/input
  - storybook: https://yamada-ui.github.io/yamada-ui?path=/story/components-input--basic
---

```tsx
<Input placeholder="Placeholder" />
```

## Usage

```tsx
import { Input, InputGroup } from "@yamada-ui/react"
```

```tsx
import { Input, InputGroup } from "@/components/ui"
```

```tsx
import { Input, InputGroup } from "@workspaces/ui"
```

```tsx
<Input />
```

```tsx
<InputGroup.Root>
  <InputGroup.Addon />
  <Input />
  <InputGroup.Element />
</InputGroup.Root>
```

### Change Variant

```tsx
<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => (
      <Input
        key={variant}
        variant={variant}
        placeholder={toTitleCase(variant)}
      />
    )}
  </For>
</VStack>
```

### Change Size

```tsx preview
<VStack>
  <For each={["sm", "md", "lg"]}>
    {(size) => <Input key={size} size={size} placeholder={`Size (${size})`} />}
  </For>
</VStack>
```

### Change Color Scheme

```tsx
<VStack>
  <For each={["success", "warning"]}>
    {(colorScheme) => (
      <Input
        key={colorScheme}
        colorScheme={colorScheme}
        placeholder={toTitleCase(colorScheme)}
      />
    )}
  </For>
</VStack>
```

### Disable

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

```tsx
<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => (
      <Input
        key={variant}
        disabled
        variant={variant}
        placeholder={toTitleCase(variant)}
      />
    )}
  </For>
</VStack>
```

### Read-Only

To read-only, set `readOnly` to `true`.

```tsx
<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => (
      <Input
        key={variant}
        readOnly
        variant={variant}
        placeholder={toTitleCase(variant)}
      />
    )}
  </For>
</VStack>
```

### Invalid

To make invalid, set `invalid` to `true`.

```tsx
<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => (
      <Input
        key={variant}
        invalid
        variant={variant}
        placeholder={toTitleCase(variant)}
      />
    )}
  </For>
</VStack>
```

### Add Addons

To add addons, wrap the `Input` in `InputGroup` and use `InputGroup.Addon`.

```tsx
<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => (
      <InputGroup.Root key={variant} variant={variant}>
        <InputGroup.Addon>https://</InputGroup.Addon>
        <Input placeholder="Your site address" />
        <InputGroup.Addon>.com</InputGroup.Addon>
      </InputGroup.Root>
    )}
  </For>
</VStack>
```

### Add Elements

To add elements, wrap the `Input` in `InputGroup` and use `InputGroup.Element`.

```tsx
<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => (
      <InputGroup.Root key={variant} variant={variant}>
        <InputGroup.Element>
          <PhoneIcon />
        </InputGroup.Element>
        <Input type="tel" placeholder="Your phone number" />
      </InputGroup.Root>
    )}
  </For>
</VStack>
```

### Change Type

To change the type, set `type` to the [type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types).

```tsx
<Input placeholder="Select Date and Time" type="datetime-local" />
```

### Change Border Color

To change the border color, set `focusBorderColor` or `errorBorderColor` to the color.

```tsx
<VStack>
  <Input focusBorderColor="green.500" placeholder="Custom focus border color" />
  <Input
    errorBorderColor="orange.500"
    invalid
    placeholder="Custom invalid border color"
  />
</VStack>
```

### Change Placeholder Color

To change the placeholder color, set `_placeholder` to the value.

```tsx
<Input placeholder="Custom placeholder" _placeholder={{ color: "blue.500" }} />
```

### Floating Label

```tsx
<Field.Root>
  <Input type="email" data-peer placeholder="" />
  <Field.Label
    css={{
      bg: "bg",
      fontSize: "sm",
      fontWeight: "normal",
      insetStart: "2",
      pointerEvents: "none",
      position: "absolute",
      px: "1",
      top: "-12px",
      transitionDuration: "moderate",
      transitionProperty: "top, color, font-size",
      transitionTimingFunction: "ease-in-out",
      zIndex: "yamcha",
      _peerPlaceholderShown: {
        color: "fg.subtle",
        fontSize: "md",
        insetStart: "2",
        top: "5px",
      },
      _peerFocusVisible: {
        color: "fg",
        fontSize: "sm",
        insetStart: "2",
        top: "-12px",
      },
    }}
  >
    Email
  </Field.Label>
</Field.Root>
```

### Control

```tsx
const [value, setValue] = useState<string>("オッス！オラ悟空！")

return <Input value={value} onChange={(ev) => setValue(ev.target.value)} />
```

## Props

### Input

| 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" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"`                                                                                                                   | The size of the component.                                    |
| `variant`          | `"outline"` | `"filled" \| "flushed" \| "outline" \| "plain"`                                                                                                                   | The variant of the component.                                 |
| `errorBorderColor` | -           | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is invalid.                   |
| `focusBorderColor` | -           | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is focused.                   |
| `htmlSize`         | -           | `number`                                                                                                                                                          | The native HTML `size` attribute to be passed to the `input`. |
| `invalid`          | `false`     | `boolean`                                                                                                                                                         | If `true`, the field will be invalid.                         |

### InputGroup.Root

| 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" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"`                                                                                                                   | The size of the component.                                                                               |
| `variant`          | `"outline"`    | `"filled" \| "flushed" \| "outline" \| "plain"`                                                                                                                   | The variant of the component.                                                                            |
| `align`            | -              | `"-moz-initial" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" \| "revert-layer" ...`                     | The CSS `align-items` property.                                                                          |
| `attached`         | `false`        | `boolean`                                                                                                                                                         | If `true`, the borderRadius of button that are direct children will be altered to look flushed together. |
| `basis`            | -              | `"-moz-fit-content" \| "-moz-initial" \| "-moz-max-content" \| "-moz-min-content" \| "-webkit-auto" \| "0.5" \| "1.5" \| "1" \| "1/12" \| "1/2" ...`              | The CSS `flex-basis` property.                                                                           |
| `direction`        | -              | `"-moz-initial" \| "column-reverse" \| "column" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "row-reverse" \| "row" \| "unset" ...`                 | The CSS `flex-direction` property.                                                                       |
| `disabled`         | `false`        | `boolean`                                                                                                                                                         | If `true`, the field will be disabled.                                                                   |
| `errorBorderColor` | -              | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is invalid.                                                              |
| `focusBorderColor` | -              | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is focused.                                                              |
| `grow`             | `false`        | `boolean`                                                                                                                                                         | If `true`, the children will grow to fill the available space.                                           |
| `invalid`          | `false`        | `boolean`                                                                                                                                                         | If `true`, the field will be invalid.                                                                    |
| `justify`          | -              | `"-moz-initial" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "left" \| "normal" \| "revert-layer" ...`                         | The CSS `justify-content` property.                                                                      |
| `orientation`      | `"horizontal"` | `"horizontal" \| "vertical"`                                                                                                                                      | The orientation of the group.                                                                            |
| `readOnly`         | `false`        | `boolean`                                                                                                                                                         | If `true`, the field will be readonly.                                                                   |
| `required`         | `false`        | `boolean`                                                                                                                                                         | If `true`, the field will be required.                                                                   |
| `shrink`           | -              | `"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| number & {} ...`                                                            | The CSS `flex-shrink` property.                                                                          |
| `stacking`         | -              | `"first-on-top" \| "last-on-top"`                                                                                                                                 | The stacking order of the group.                                                                         |
| `wrap`             | -              | `"-moz-initial" \| "inherit" \| "initial" \| "nowrap" \| "revert-layer" \| "revert" \| "unset" \| "wrap-reverse" \| "wrap" ...`                                   | The CSS `flex-wrap` property.                                                                            |

### InputGroup.Addon

| 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" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"`                                                                                                                   | The size of the component.                  |
| `variant`          | `"outline"` | `"filled" \| "flushed" \| "outline" \| "plain"`                                                                                                                   | The variant of the component.               |
| `errorBorderColor` | -           | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is invalid. |
| `focusBorderColor` | -           | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is focused. |

### InputGroup.Element

| 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.                 |
| `clickable`        | `false`   | `boolean`                                                                                                                                                         | If `true`, the element clickable.           |
| `errorBorderColor` | -         | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is invalid. |
| `focusBorderColor` | -         | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The border color when the input is focused. |
| `placement`        | `"start"` | `"end" \| "start"`                                                                                                                                                | The placement of the element.               |

## Accessibility

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