Input

The Input component is a component that is used to get user input in a text field.

Import#

import { Input } from "@chakra-ui/react"

import { Input } from "@chakra-ui/react"

Usage#

Here's a basic usage example of the Input component:

<Input placeholder="Basic usage" />

<Input placeholder="Basic usage" />

Editable Example

Changing the size of the Input#

There are three sizes of an Input:

sm (24px)
md (32px)
lg (40px)

<Stack spacing={3}>
  <Input placeholder="large size" size="lg" />
  <Input placeholder="default size" size="md" />
  <Input placeholder="small size" size="sm" />
</Stack>

<Stack spacing={3}>
  <Input placeholder="large size" size="lg" />
  <Input placeholder="default size" size="md" />
  <Input placeholder="small size" size="sm" />
</Stack>

Editable Example

Changing the appearance of the input#

The input component comes in 4 variants: outline, unstyled, flushed, and filled. Pass the variant prop and set it to one of these values.

<Stack spacing={3}>
  <Input variant="outline" placeholder="Outline" />
  <Input variant="filled" placeholder="Filled" />
  <Input variant="flushed" placeholder="Flushed" />
  <Input variant="unstyled" placeholder="Unstyled" />
</Stack>

<Stack spacing={3}>
  <Input variant="outline" placeholder="Outline" />
  <Input variant="filled" placeholder="Filled" />
  <Input variant="flushed" placeholder="Flushed" />
  <Input variant="unstyled" placeholder="Unstyled" />
</Stack>

Editable Example

Left and Right Addons#

Like bootstrap, you can add addons to the left and right of the Input component. Chakra UI exports InputGroup, InputLeftAddon, and InputRightAddon to help with this use case.

+234

https://

.com

<Stack spacing={4}>
  <InputGroup>
    <InputLeftAddon children="+234" />
    <Input type="phone" borderLeftRadius="0" placeholder="phone number" />
  </InputGroup>

  {/* If you add the size prop to `InputGroup`, it'll pass it to all its children. */}
  <InputGroup size="sm">
    <InputLeftAddon children="https://" />
    <Input borderRadius="0" placeholder="mysite" />
    <InputRightAddon children=".com" />
  </InputGroup>
</Stack>

<Stack spacing={4}>
  <InputGroup>
    <InputLeftAddon children="+234" />
    <Input type="phone" borderLeftRadius="0" placeholder="phone number" />
  </InputGroup>
  {/* If you add the size prop to `InputGroup`, it'll pass it to all its children. */}
  <InputGroup size="sm">
    <InputLeftAddon children="https://" />
    <Input borderRadius="0" placeholder="mysite" />
    <InputRightAddon children=".com" />
  </InputGroup>
</Stack>

Editable Example

Add elements inside Input#

In some scenarios, you might need to add an icon or button inside the input component. Chakra UI exports InputLeftElement and InputRightElement to help with this use case.

If the left or right is an icon or text, you can pass pointerEvents="none" to InputLeftElement or InputRightElement to ensure that clicking on them focused the input.

<Stack spacing={4}>
  <InputGroup>
    <InputLeftElement
      pointerEvents="none"
      children={<PhoneIcon color="gray.300" />}
    />
    <Input type="phone" placeholder="Phone number" />
  </InputGroup>

  <InputGroup>
    <InputLeftElement
      pointerEvents="none"
      color="gray.300"
      fontSize="1.2em"
      children="$"
    />
    <Input placeholder="Enter amount" />
    <InputRightElement children={<CheckIcon color="green.500" />} />
  </InputGroup>
</Stack>

<Stack spacing={4}>
  <InputGroup>
    <InputLeftElement
      pointerEvents="none"
      children={<PhoneIcon color="gray.300" />}
    />
    <Input type="phone" placeholder="Phone number" />
  </InputGroup>
  <InputGroup>
    <InputLeftElement
      pointerEvents="none"
      color="gray.300"
      fontSize="1.2em"
      children="$"
    />
    <Input placeholder="Enter amount" />
    <InputRightElement children={<CheckIcon color="green.500" />} />
  </InputGroup>
</Stack>

Editable Example

Password Input Example#

Let's use these components to create a password input with a show/hide password functionality:

function PasswordInput() {
  const [show, setShow] = React.useState(false)
  const handleClick = () => setShow(!show)

  return (
    <InputGroup size="md">
      <Input
        pr="4.5rem"
        type={show ? "text" : "password"}
        placeholder="Enter password"
      />
      <InputRightElement width="4.5rem">
        <Button h="1.75rem" size="sm" onClick={handleClick}>
          {show ? "Hide" : "Show"}
        </Button>
      </InputRightElement>
    </InputGroup>
  )
}

function PasswordInput() {
  const [show, setShow] = React.useState(false)
  const handleClick = () => setShow(!show)
  return (
    <InputGroup size="md">
      <Input
        pr="4.5rem"
        type={show ? "text" : "password"}
        placeholder="Enter password"
      />
      <InputRightElement width="4.5rem">
        <Button h="1.75rem" size="sm" onClick={handleClick}>
          {show ? "Hide" : "Show"}
        </Button>
      </InputRightElement>
    </InputGroup>
  )
}

Editable Example

Controlled Input#

Value:

function Example() {
  const [value, setValue] = React.useState("")
  const handleChange = (event) => setValue(event.target.value)

  return (
    <>
      <Text mb="8px">Value: {value}</Text>
      <Input
        value={value}
        onChange={handleChange}
        placeholder="Here is a sample placeholder"
        size="sm"
      />
    </>
  )
}

function Example() {
  const [value, setValue] = React.useState("")
  const handleChange = (event) => setValue(event.target.value)
  return (
    <>
      <Text mb="8px">Value: {value}</Text>
      <Input
        value={value}
        onChange={handleChange}
        placeholder="Here is a sample placeholder"
        size="sm"
      />
    </>
  )
}

Editable Example

Changing the focus and error border colors#

You can change the border color that shows when the input receives focus (focusBorderColor) and when isInvalid is set to true (errorBorderColor). The value can be set to a color in the theme object, like teal.400, or a raw CSS value.

<Stack spacing={3}>
  <Input focusBorderColor="lime" placeholder="Here is a sample placeholder" />
  <Input
    focusBorderColor="pink.400"
    placeholder="Here is a sample placeholder"
  />
  <Input
    isInvalid
    errorBorderColor="red.300"
    placeholder="Here is a sample placeholder"
  />
  <Input
    isInvalid
    errorBorderColor="crimson"
    placeholder="Here is a sample placeholder"
  />
</Stack>

<Stack spacing={3}>
  <Input focusBorderColor="lime" placeholder="Here is a sample placeholder" />
  <Input
    focusBorderColor="pink.400"
    placeholder="Here is a sample placeholder"
  />
  <Input
    isInvalid
    errorBorderColor="red.300"
    placeholder="Here is a sample placeholder"
  />
  <Input
    isInvalid
    errorBorderColor="crimson"
    placeholder="Here is a sample placeholder"
  />
</Stack>

Editable Example

Props#

The Input component composes Box so you can pass all Box props, and React.InputHTMLAttributes.

Name	Type	Description	Default
colorScheme	`string`		-
css	`Interpolation<{}>`	The emotion's css style object	-
errorBorderColor	`string`	The border color when the input is invalid. Use color keys in `theme.colors` @example errorBorderColor = "red.500"	-
focusBorderColor	`string`	The border color when the input is focused. Use color keys in `theme.colors` @example focusBorderColor = "blue.500"	-
isDisabled	`boolean`	If `true`, the form control will be disabled. This has 2 side effects: - The `FormLabel` will have `data-disabled` attribute - The form element (e.g, Input) will be disabled	-
isFullWidth	`boolean`	If `true`, the input element will span the full width of its parent	-
isInvalid	`boolean`	If `true`, the form control will be invalid. This has 2 side effects: - The `FormLabel` and `FormErrorIcon` will have `data-invalid` set to `true` - The form element (e.g, Input) will have `aria-invalid` set to `true`	-
isLoading	`boolean`	If `true`, the form control will be in its `loading` state	-
isReadOnly	`boolean`	If `true`, the form control will be readonly	-
isRequired	`boolean`	If `true`, the form control will required. This has 2 side effects: - The `FormLabel` will show a required indicator - The form element (e.g, Input) will have `aria-requred` set to `true`	-
orientation	`"horizontal" \| "vertical"`		-
size	`string`		-
styleConfig	`Record<string, any>`		-
variant	`string`		-

Edit this page

Input

.css-12m0k8p{pointer-events:auto;}Import.css-1l2j62r{color:#319795;font-weight:400;outline:none;opacity:0;margin-left:0.375rem;}.css-1l2j62r:focus,.css-1l2j62r[data-focus]{opacity:1;box-shadow:0 0 0 3px rgba(66, 153, 225, 0.6);}#

Usage#

Changing the size of the Input#

Changing the appearance of the input#

Left and Right Addons#

Add elements inside Input#

Password Input Example#

Controlled Input#

Changing the focus and error border colors#

Props#

Import#