Input Group

Add addons, buttons, and helper content to inputs.

12 results

Installation


npx shadcn@latest add @rescript-shadcn/InputGroup

Usage

<InputGroup>
  <InputGroup.Input placeholder="Search..." />
  <InputGroup.Addon>
    <Icons.Search />
  </InputGroup.Addon>
</InputGroup>

Align

Use the align prop on InputGroupAddon to position the addon relative to the input.

For proper focus management, InputGroupAddon should always be placed after InputGroupInput or InputGroupTextarea in the DOM. Use the align prop to visually position the addon.

inline-start

Use align=InlineStart to position the addon at the start of the input. This is the default.

inline-end

Use align=InlineEnd to position the addon at the end of the input.

block-start

Use align=BlockStart to position the addon above the input.

block-end

Use align=BlockEnd to position the addon below the input.

Examples

Icon

Text

USD

https://

.com

@company.com

120 characters left

Button

Kbd

⌘K

Spinner

Saving...

Please wait...

Textarea

Line 1, Column 1

script.js

Custom Input

Add the data-slot="input-group-control" attribute to your custom input for automatic focus state handling.

Here's an example of a custom resizable textarea from a third-party library.

API Reference

InputGroup

The main component that wraps inputs and addons.

Prop	Type	Default
`className`	`string`

<InputGroup>
  <InputGroupInput />
  <InputGroupAddon />
</InputGroup>

InputGroupAddon

Displays icons, text, buttons, or other content alongside inputs.

Focus Navigation

For proper focus navigation, the InputGroupAddon component should be placed after the input. Set the align prop to position the addon.

Prop	Type	Default
`align`	`InlineStart \| InlineEnd \| BlockStart \| BlockEnd`	`InlineStart`
`className`	`string`

<InputGroupAddon align=InlineEnd>
  <SearchIcon />
</InputGroupAddon>

For <InputGroupInput />, use the InlineStart or InlineEnd alignment. For <InputGroupTextarea />, use the BlockStart or BlockEnd alignment.

The InputGroupAddon component can have multiple InputGroupButton components and icons.

<InputGroupAddon>
  <InputGroupButton> {"Button"->React.string} </InputGroupButton>
  <InputGroupButton> {"Button"->React.string} </InputGroupButton>
</InputGroupAddon>

InputGroupButton

Displays buttons within input groups.

Prop	Type	Default
`size`	`Xs \| IconXs \| Sm \| IconSm`	`"xs"`
`variant`	`Default \| Destructive \| Outline \| Secondary \| Ghost \| Link`	`Ghost`
`className`	`string`

<InputGroupButton> {"Button"->React.string} </InputGroupButton>
<InputGroupButton size=IconXs ariaLabel="Copy">
  <CopyIcon />
</InputGroupButton>

InputGroupInput

Replacement for <Input /> when building input groups. This component has the input group styles pre-applied and uses the unified data-slot="input-group-control" for focus state handling.

Prop	Type	Default
`className`	`string`

All other props are passed through to the underlying <Input /> component.

<InputGroup>
  <InputGroupInput placeholder="Enter text..." />
  <InputGroupAddon>
    <SearchIcon />
  </InputGroupAddon>
</InputGroup>

InputGroupTextarea

Replacement for <Textarea /> when building input groups. This component has the textarea group styles pre-applied and uses the unified data-slot="input-group-control" for focus state handling.

Prop	Type	Default
`className`	`string`

All other props are passed through to the underlying <Textarea /> component.

<InputGroup>
  <InputGroupTextarea placeholder="Enter message..." />
  <InputGroupAddon align=BlockEnd>
    <InputGroupButton> {"Send"->React.string} </InputGroupButton>
  </InputGroupAddon>
</InputGroup>