Input

Retrieve text input from a user.

Usage

First of all, you need to import the Input component from the kitchn package.

import { Input } from "kitchn"

Default

Code Editor

<Input placeholder={"Placeholder..."} />

Sizes

Code Editor

<Container row gap={"small"}>
  <Container align="flex-start">
    <Input size="small" placeholder="Small" />
  </Container>

  <Container align="flex-start">
    <Input placeholder="Default" />
  </Container>

  <Container align="flex-start">
    <Input size="large" placeholder="Large" />
  </Container>
</Container>

Sizes, prefix, and suffix

Code Editor

<Container row gap={"small"}>
  <Container align="flex-start">
    <Input
      size="small"
      placeholder="Small"
      prefix={<RiArrowUpCircleLine />}
      suffix={<RiArrowUpCircleLine />}
    />
  </Container>

  <Container align="flex-start">
    <Input
      placeholder="Default"
      prefix={<RiArrowUpCircleLine />}
      suffix={<RiArrowUpCircleLine />}
    />
  </Container>

  <Container align="flex-start">
    <Input
      size="large"
      placeholder="Large"
      prefix={<RiArrowUpCircleLine />}
      suffix={<RiArrowUpCircleLine />}
    />
  </Container>
</Container>

Disabled

Code Editor

<Container row gap={"small"}>
  <Container>
    <Input placeholder="Disabled with placeholder" disabled />
  </Container>

  <Container>
    <Input value="Disabled with value" disabled />
  </Container>
</Container>

Prefix and suffix

https://.com

kitchn/

Code Editor

<Container gap={"small"} align={"flex-start"}>
  <Container>
    <Input placeholder="Default" prefix={<RiArrowUpCircleLine />} />
  </Container>

  <Container>
    <Input placeholder="Default" suffix={<RiArrowUpCircleLine />} />
  </Container>

  <Container>
    <Input placeholder="Default" prefix="https://" suffix=".com" />
  </Container>

  <Container>
    <Input
      placeholder="Default"
      prefix={<RiArrowUpCircleLine />}
      suffix={<RiArrowUpCircleLine />}
      prefixStyling={false}
      suffixStyling={false}
    />
  </Container>

  <Container>
    <Input
      placeholder="Default"
      prefix="kitchn/"
      suffix={<RiArrowUpCircleLine />}
      suffixStyling={false}
      suffixContainer={false}
    />
  </Container>
</Container>

Prefix and suffix disabled

https://.com

kitchn/

Code Editor

<Container gap={"small"} align={"flex-start"}>
  <Container>
    <Input placeholder="Default" prefix={<RiArrowUpCircleLine />} disabled />
  </Container>

  <Container>
    <Input placeholder="Default" suffix={<RiArrowUpCircleLine />} disabled />
  </Container>

  <Container>
    <Input placeholder="Default" prefix="https://" suffix=".com" disabled />
  </Container>

  <Container>
    <Input
      placeholder="Default"
      prefix={<RiArrowUpCircleLine />}
      suffix={<RiArrowUpCircleLine />}
      prefixStyling={false}
      suffixStyling={false}
      disabled
    />
  </Container>

  <Container>
    <Input
      placeholder="Default"
      prefix="kitchn/"
      suffix={<RiArrowUpCircleLine />}
      suffixStyling={false}
      suffixContainer={false}
      disabled
    />
  </Container>
</Container>

Clearable

https://

Error: A valid email address is required.

Code Editor

<Container gap={"small"} align={"flex-start"}>
  <Container>
    <Input clearable placeholder="Enter some text..." value={"hey"} />
  </Container>

  <Container>
    <Input
      clearable
      placeholder="Really really long placeholder text..."
    />
  </Container>

  <Container>
    <Input clearable disabled placeholder="Disabled" />
  </Container>

  <Container>
    <Input clearable disabled value="Disabled with value" />
  </Container>

  <Container>
    <Input clearable placeholder="Custom width" width={300} />
  </Container>

  <Container>
    <Input
      clearable
      prefix="https://"
      placeholder="tonightpass.com"
    />
  </Container>

  <Container>
    <Input
      clearable
      placeholder="Enter some text..."
      error="A valid email address is required."
    />
  </Container>
</Container>

Types

Code Editor

<Container row gap={"small"}>
  <Container>
    <Input placeholder="Default" type="danger" />
  </Container>

  <Container>
    <Input placeholder="Default" type="warning" />
  </Container>

  <Container>
    <Input placeholder="Default" type="success" />
  </Container>
</Container>

Error

Error: A valid email address is required.

Error: A valid email address is required so that we can verify your GitHub installation. In the event that you cannot provide a valid email address, please contact support.

Code Editor

<Container gap={"small"}>
  <Container>
    <Input
      placeholder="error@gmail.com"
      error="A valid email address is required."
    />
  </Container>

  <Container>
    <Input
      width={200}
      placeholder="wrapping-error@gmail.com"
      error="A valid email address is required so that we can verify your GitHub installation. In the event that you cannot provide a valid email address, please contact support."
    />
  </Container>

  <Container>
    <Input
      size="small"
      placeholder="small-error@gmail.com"
      error="A valid email address is required so that we can verify your GitHub installation. In the event that you cannot provide a valid email address, please contact support."
    />
  </Container>

  <Container>
    <Input
      placeholder="long-error@gmail.com"
      error="A valid email address is required so that we can verify your GitHub installation. In the event that you cannot provide a valid email address, please contact support."
    />
  </Container>

  <Container>
    <Input
      size="large"
      placeholder="large-error@gmail.com"
      error="A valid email address is required so that we can verify your GitHub installation. In the event that you cannot provide a valid email address, please contact support."
    />
  </Container>
</Container>

Label

My label

Code Editor

<Container>
  <Input placeholder="With label" label="My label" />
</Container>

Props

Name	Type	Default	Required	Description	Accepted values
`placeholder`	`string`	-	-	The placeholder of the input.	-
`prefix`	`JSX.Element` \| `string`	-	-	The prefix of the input.	-
`suffix`	`JSX.Element` \| `string`	-	-	The suffix of the input.	-
`initialValue`	`string`	-	-	The initial value of the input.	-
`value`	`string`	-	-	The value of the input.	-
`disabled`	`boolean`	`false`	-	The status of the input (disabled or not).	-
`prefixStyling`	`boolean`	`true`	-	The status of the prefix (styled or not).	-
`suffixStyling`	`boolean`	`true`	-	The status of the suffix (styled or not).	-
`prefixContainer`	`boolean`	`true`	-	The status of the prefix container (whether there is one or not).	-
`suffixContainer`	`boolean`	`true`	-	The status of the suffix container (whether there is one or not).	-
`clearable`	`boolean`	`false`	-	The type of the input (clearable or not).	-
`width`	`number` \| `string`	-	-	The width of the input.	-
`error`	`string`	-	-	The error message of the input.	-
`readOnly`	`boolean`	`false`	-	The type of the input (read-only or not).	-
`onClearClick`	`(event: React.MouseEvent<HTMLDivElement>) => void`	-	-	The click event handler of the input's clear button.	-
`readOnly`	`boolean`	`false`	-	The type of the input (read-only or not).	-
`type`	`string`	-	-	The type of the input.	`primary`, `secondary`, `info`, `success`, `warning`, `danger`, `light`, `dark`
`label`	`string`	-	-	The label of the input.	-

Last updated on September 18, 2024

React Image component React Link component