Glrk UI

Input Group

Composable input with inline and block addons — text labels, icons, and buttons — built on a flex container wrapper.

Text addons
addonStart — prefix text (@)
@
addonEnd — suffix text (.com)
.com
addonStart — prefix icon
addonStart + addonEnd — currency
USD
Button addons
addonEnd — icon button (copy)
addonStart icon + addonEnd button
State
Disabled
@
InputGroupWrapper (field-wrapper)
With label
USD
Error state
@

Installation

npx shadcn@latest add @glrk-ui/input-group

If you haven't set up the prerequisites yet, check out Prerequest section.

Copy and paste the following code into your project.

ui/input-group.tsx
'use client'

import * as React from 'react'
import { cva, type VariantProps } from 'class-variance-authority'

import { cn } from '@/lib/utils'

import { Textarea } from '@/components/ui/textarea'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'

function InputGroup({ className, ...props }: React.ComponentProps<'div'>) {
  return (
    <div
      data-slot="input-group"
      role="group"
      className={cn(
        'group/input-group relative flex h-9 w-full min-w-0 items-center rounded-md border border-input shadow-xs transition-colors outline-none in-data-[slot=combobox-content]:focus-within:border-inherit in-data-[slot=combobox-content]:focus-within:ring-0 has-disabled:bg-input/50 has-disabled:opacity-50 has-[[data-slot=input-group-control]:focus-visible]:border-ring has-[[data-slot=input-group-control]:focus-visible]:ring-3 has-[[data-slot=input-group-control]:focus-visible]:ring-ring/50 has-[[data-slot][aria-invalid=true]]:border-destructive has-[[data-slot][aria-invalid=true]]:ring-3 has-[[data-slot][aria-invalid=true]]:ring-destructive/20 has-[>[data-align=block-end]]:h-auto has-[>[data-align=block-end]]:flex-col has-[>[data-align=block-start]]:h-auto has-[>[data-align=block-start]]:flex-col has-[>textarea]:h-auto dark:bg-input/30 dark:has-disabled:bg-input/80 dark:has-[[data-slot][aria-invalid=true]]:ring-destructive/40 has-[>[data-align=block-end]]:[&>input]:pt-3 has-[>[data-align=block-start]]:[&>input]:pb-3 has-[>[data-align=inline-end]]:[&>input]:pr-1.5 has-[>[data-align=inline-start]]:[&>input]:pl-1.5',
        className,
      )}
      {...props}
    />
  )
}

const inputGroupAddonVariants = cva(
  "flex h-auto cursor-text items-center justify-center gap-2 py-1.5 text-sm font-medium text-muted-foreground select-none group-data-[disabled=true]/input-group:opacity-50 [&>kbd]:rounded-[calc(var(--radius)-5px)] [&>svg:not([class*='size-'])]:size-4",
  {
    variants: {
      align: {
        'inline-start': 'order-first pl-2 has-[>button]:ml-[-0.3rem] has-[>kbd]:ml-[-0.15rem]',
        'inline-end': 'order-last pr-2 has-[>button]:mr-[-0.3rem] has-[>kbd]:mr-[-0.15rem]',
        'block-start':
          'order-first w-full justify-start px-2.5 pt-2 group-has-[>input]/input-group:pt-2 [.border-b]:pb-2',
        'block-end':
          'order-last w-full justify-start px-2.5 pb-2 group-has-[>input]/input-group:pb-2 [.border-t]:pt-2',
      },
    },
    defaultVariants: {
      align: 'inline-start',
    },
  },
)

function InputGroupAddon({
  className,
  align = 'inline-start',
  ...props
}: React.ComponentProps<'div'> & VariantProps<typeof inputGroupAddonVariants>) {
  return (
    <div
      role="group"
      data-slot="input-group-addon"
      data-align={align}
      className={cn(inputGroupAddonVariants({ align }), className)}
      onClick={e => {
        if ((e.target as HTMLElement).closest('button')) {
          return
        }
        e.currentTarget.parentElement?.querySelector('input')?.focus()
      }}
      {...props}
    />
  )
}

const inputGroupButtonVariants = cva('flex items-center gap-2 text-sm shadow-none', {
  variants: {
    size: {
      xs: "h-6 gap-1 rounded-[calc(var(--radius)-3px)] px-1.5 [&>svg:not([class*='size-'])]:size-3.5",
      sm: '',
      'icon-xs': 'size-6 rounded-[calc(var(--radius)-3px)] p-0 has-[>svg]:p-0',
      'icon-sm': 'size-8 p-0 has-[>svg]:p-0',
    },
  },
  defaultVariants: {
    size: 'xs',
  },
})

function InputGroupButton({
  className,
  type = 'button',
  variant = 'ghost',
  size = 'xs',
  ...props
}: Omit<React.ComponentProps<typeof Button>, 'size' | 'type'> &
  VariantProps<typeof inputGroupButtonVariants> & {
    type?: 'button' | 'submit' | 'reset'
  }) {
  return (
    <Button
      type={type}
      data-size={size}
      variant={variant}
      className={cn(inputGroupButtonVariants({ size }), className)}
      {...props}
    />
  )
}

function InputGroupText({ className, ...props }: React.ComponentProps<'span'>) {
  return (
    <span
      className={cn(
        "flex items-center gap-2 text-sm text-muted-foreground [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4",
        className,
      )}
      {...props}
    />
  )
}

function InputGroupInput({ className, ...props }: React.ComponentProps<'input'>) {
  return (
    <Input
      data-slot="input-group-control"
      className={cn(
        'flex-1 rounded-none border-0 bg-transparent shadow-none ring-0 focus-visible:ring-0 disabled:bg-transparent aria-invalid:ring-0 dark:bg-transparent dark:disabled:bg-transparent',
        className,
      )}
      {...props}
    />
  )
}

function InputGroupTextarea({ className, ...props }: React.ComponentProps<'textarea'>) {
  return (
    <Textarea
      data-slot="input-group-control"
      className={cn(
        'flex-1 resize-none rounded-none border-0 bg-transparent py-2 shadow-none ring-0 focus-visible:ring-0 disabled:bg-transparent aria-invalid:ring-0 dark:bg-transparent dark:disabled:bg-transparent',
        className,
      )}
      {...props}
    />
  )
}

type InputGroupWrapperProps = React.ComponentProps<'input'> & {
  addonStart?: React.ReactNode
  addonEnd?: React.ReactNode
  wrapperClassName?: string
}

function InputGroupWrapper({
  addonStart,
  addonEnd,
  wrapperClassName,
  className,
  ...props
}: InputGroupWrapperProps) {
  return (
    <InputGroup className={wrapperClassName}>
      {addonStart && <InputGroupAddon align="inline-start">{addonStart}</InputGroupAddon>}
      <InputGroupInput className={className} {...props} />
      {addonEnd && <InputGroupAddon align="inline-end">{addonEnd}</InputGroupAddon>}
    </InputGroup>
  )
}

export {
  InputGroup,
  InputGroupAddon,
  InputGroupButton,
  InputGroupText,
  InputGroupInput,
  InputGroupTextarea,
  InputGroupWrapper,
  type InputGroupWrapperProps,
}

Usage

Standalone (InputGroupWrapper)

import { InputGroupWrapper, InputGroupText } from "@/components/ui/input-group"

<InputGroupWrapper
  placeholder="username"
  addonStart={<InputGroupText>@</InputGroupText>}
/>

With icon prefix

import { SearchIcon } from "lucide-react"

<InputGroupWrapper
  placeholder="Search..."
  addonStart={<InputGroupText><SearchIcon /></InputGroupText>}
/>

With text suffix

<InputGroupWrapper
  placeholder="yoursite"
  addonEnd={<InputGroupText>.com</InputGroupText>}
/>

With button addon

import { CopyIcon } from "lucide-react"
import { InputGroupWrapper, InputGroupButton, InputGroupText } from "@/components/ui/input-group"

<InputGroupWrapper
  defaultValue="https://example.com"
  readOnly
  addonEnd={
    <InputGroupButton>
      <CopyIcon />
    </InputGroupButton>
  }
/>

With field label and error (InputGroupWrapper)

InputGroupWrapper from field-wrapper wraps the input group inside a Field with label and error display:

import { InputGroupWrapper } from "@/components/ui/field-wrapper"
import { InputGroupText } from "@/components/ui/input-group"
import { DollarSignIcon } from "lucide-react"

<InputGroupWrapper
  name="amount"
  label="Amount"
  placeholder="0.00"
  addonStart={<InputGroupText><DollarSignIcon /></InputGroupText>}
  addonEnd={<InputGroupText>USD</InputGroupText>}
/>

With validation error

<InputGroupWrapper
  name="username"
  label="Username"
  placeholder="username"
  addonStart={<InputGroupText>@</InputGroupText>}
  invalid
  error={{ message: "Username is already taken." }}
/>

React Hook Form

import { InputGroupWrapper } from "@/components/ui/field-wrapper-rhf"
import { InputGroupText } from "@/components/ui/input-group"

<InputGroupWrapper
  name="username"
  label="Username"
  control={form.control}
  addonStart={<InputGroupText>@</InputGroupText>}
  placeholder="username"
/>

TanStack Form

import { InputGroupText } from "@/components/ui/input-group"

<form.AppField name="username">
  {field => (
    <field.InputGroupField
      label="Username"
      placeholder="username"
      addonStart={<InputGroupText>@</InputGroupText>}
    />
  )}
</form.AppField>

Using primitives

import {
  InputGroup,
  InputGroupAddon,
  InputGroupButton,
  InputGroupText,
  InputGroupInput,
  InputGroupTextarea,
} from "@/components/ui/input-group"

<InputGroup>
  <InputGroupAddon align="inline-start">
    <InputGroupText>@</InputGroupText>
  </InputGroupAddon>
  <InputGroupInput placeholder="username" />
  <InputGroupAddon align="inline-end">
    <InputGroupButton><CopyIcon /></InputGroupButton>
  </InputGroupAddon>
</InputGroup>

Addon alignment options

// inline addons (default) — left/right of input on same line
<InputGroupAddon align="inline-start">...</InputGroupAddon>
<InputGroupAddon align="inline-end">...</InputGroupAddon>

// block addons — above/below the input (stacked layout)
<InputGroupAddon align="block-start">Character limit: 280</InputGroupAddon>
<InputGroupInput />
<InputGroupAddon align="block-end">0 / 280</InputGroupAddon>

Reference

InputGroupWrapper (standalone)

Prop

Type