Input Group
Add addons, buttons, and helper content to inputs.
npx shadcn@latest add @velaui/input-grouppnpm dlx velaui add @velaui/input-groupyarn dlx shadcn@latest add @velaui/input-groupbunx --bun shadcn@latest add @velaui/input-groupveni add input-groupInstalls the copy of vela-ui that veni-builder serves to Venizia apps; veni-builder serves the Radix UI copy only, so this tab exists for that base alone.
npx shadcn@latest add @velaui/input-grouppnpm dlx velaui add @velaui/input-groupyarn dlx shadcn@latest add @velaui/input-groupbunx --bun shadcn@latest add @velaui/input-groupExamples
- Start icon
- End icon
- Start text
- Start text icon
- End text
- End text icon
- Text add ons
- End inline button
- Characters limit
- Icon and button
- Block start
- Block end
- Block start block end
- Chat input
- Chat input abort
- Chat messages
- Chat input vietnamese
- Chat input vietnamese error
- Chat input vietnamese disabled
Sizes
Usage
Props
InputGroup
| Prop | Type | Default |
|---|---|---|
size | "sm" | "md" | "lg" | "sm" |
variant | "fill" | "underline" | "outlined" | "outlined" |
Takes these and every prop of InputGroupProps.
InputGroupAddon
| Prop | Type | Default |
|---|---|---|
align | "inline-end" | "inline-start" | "block-start" | "block-end" | "inline-start" |
size | "sm" | "md" | "lg" | — |
Takes these and every prop of InputGroupAddonProps.
InputGroupButton
| Prop | Type | Default |
|---|---|---|
asChild | boolean | — |
size | "sm" | "xs" | "icon-xs" | "icon-sm" | "xs" |
type | "button" | "submit" | "reset" | "button" |
variant | "outline" | "link" | "destructive" | "ghost" | "primary" | "secondary" | "ghost" |
Takes these and every prop of InputGroupButtonProps.
InputGroupText
Takes every prop of React.ComponentProps<"span">.
InputGroupInput
| Prop | Type | Default |
|---|---|---|
size | "sm" | "md" | "lg" | — |
variant | "fill" | "underline" | "outlined" | — |
Takes these and every prop of InputProps.
InputGroupTextarea
Takes every prop of React.ComponentProps<"textarea">.
InputGroup
| Prop | Type | Default |
|---|---|---|
size | "sm" | "md" | "lg" | "sm" |
variant | "underline" | "fill" | "outlined" | "outlined" |
Takes these and every prop of InputGroupProps.
InputGroupAddon
| Prop | Type | Default |
|---|---|---|
align | "inline-end" | "inline-start" | "block-start" | "block-end" | "inline-start" |
size | "sm" | "md" | "lg" | — |
Takes these and every prop of InputGroupAddonProps.
InputGroupButton
| Prop | Type | Default |
|---|---|---|
size | "sm" | "xs" | "icon-xs" | "icon-sm" | "xs" |
type | "button" | "submit" | "reset" | "button" |
variant | "link" | "outline" | "destructive" | "ghost" | "primary" | "secondary" | "ghost" |
Takes these and every prop of InputGroupButtonProps.
InputGroupText
Takes every prop of React.ComponentProps<"span">.
InputGroupInput
| Prop | Type | Default |
|---|---|---|
size | "sm" | "md" | "lg" | — |
variant | "underline" | "fill" | "outlined" | — |
Takes these and every prop of InputProps.
InputGroupTextarea
Takes every prop of React.ComponentProps<"textarea">.
Dependencies
- npm
class-variance-authority@0.7.1
Source
components/ui/input-group.tsx
/* eslint-disable react-refresh/only-export-components */
import * as React from "react";
import { cva, type VariantProps } from "class-variance-authority";
import { cn } from "@/lib/utils";
import { Button } from "@/components/ui/button";
import { Input, type InputProps } from "@/components/ui/input";
import { Textarea } from "@/components/ui/textarea";
type InputGroupSize = "sm" | "md" | "lg" | null | undefined;
type InputGroupVariant = "outlined" | "fill" | "underline" | null | undefined;
type InputGroupContextType = {
size?: InputGroupSize;
variant?: InputGroupVariant;
};
const InputGroupContext = React.createContext<InputGroupContextType | null>(
null,
);
function InputGroupProvider({
children,
size,
variant,
}: {
children: React.ReactNode;
size: InputGroupSize;
variant: InputGroupVariant;
}) {
const value = React.useMemo(() => ({ size, variant }), [size, variant]);
return (
<InputGroupContext value={value}>
{children}
</InputGroupContext>
);
}
function useInputGroup() {
const context = React.useContext(InputGroupContext);
if (!context) {
throw new Error("useInputGroup must be used inside InputGroupProvider.");
}
return context;
}
const inputGroupVariants = cva(
"group/input-group relative flex w-full min-w-0 items-center text-sm leading-[1.4] transition-colors outline-none in-data-[slot=combobox-content]:focus-within:border-inherit in-data-[slot=combobox-content]:focus-within:ring-0 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 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",
{
variants: {
variant: {
outlined:
"rounded-md border border-border-default bg-bg-main hover:border-border-hover hover:bg-input-hover has-[[data-slot=input-group-control]:focus-visible]:border-ring-neutral-outline has-[[data-slot=input-group-control]:focus-visible]:bg-input-default has-[[data-slot=input-group-control]:focus-visible]:ring-3 has-[[data-slot=input-group-control]:focus-visible]:ring-ring-neutral-shadow has-disabled:border-border-disabled has-disabled:bg-input-disabled has-[[data-slot][aria-invalid=true]]:border-negative-middle has-[[data-slot][aria-invalid=true]:focus-visible]:border-negative-middle has-[[data-slot][aria-invalid=true]:focus-visible]:ring-negative-middle/25",
// Fill draws no border at rest, but hover/focus/invalid all draw a 1px
// one — reserve it as transparent so entering a state never reflows.
fill: "rounded-md border border-transparent bg-input-default hover:border-border-hover hover:bg-input-hover has-[[data-slot=input-group-control]:focus-visible]:border-ring-neutral-outline has-[[data-slot=input-group-control]:focus-visible]:ring-3 has-[[data-slot=input-group-control]:focus-visible]:ring-ring-neutral-shadow has-disabled:border-transparent has-disabled:bg-input-disabled has-[[data-slot][aria-invalid=true]]:border-negative-middle has-[[data-slot][aria-invalid=true]:focus-visible]:border-negative-middle has-[[data-slot][aria-invalid=true]:focus-visible]:ring-negative-middle/25",
// Underline carries no surface, no radius and no focus ring — the whole
// state vocabulary lives on the bottom border.
underline:
"rounded-none border-0 border-b border-b-border-default bg-transparent hover:border-b-border-active has-[[data-slot=input-group-control]:focus-visible]:border-b-border-active has-disabled:border-b-border-default has-disabled:bg-transparent has-[[data-slot][aria-invalid=true]]:border-b-negative-middle has-[[data-slot][aria-invalid=true]:focus-visible]:border-b-negative-middle",
},
size: {
sm: "h-8",
md: "h-10",
lg: "h-12",
},
},
defaultVariants: {
variant: "outlined",
size: "sm",
},
},
);
export type InputGroupProps = React.ComponentProps<"div"> & VariantProps<typeof inputGroupVariants>;
function InputGroup({
className,
variant = "outlined",
size = "sm",
...props
}: InputGroupProps) {
return (
<InputGroupProvider size={size} variant={variant}>
<div
data-slot="input-group"
data-variant={variant}
data-size={size}
role="group"
className={cn(inputGroupVariants({ variant, size }), className)}
{...props}
/>
</InputGroupProvider>
);
}
const inputGroupAddonVariants = cva(
"flex h-auto cursor-text items-center justify-center gap-2 text-sm text-text-muted select-none group-data-[disabled=true]/input-group:opacity-50 group-has-[:disabled]/input-group:text-text-disabled in-data-[variant=underline]:px-0 [&>kbd]:rounded-xs [&>svg:not([class*='size-'])]:size-4",
{
variants: {
align: {
"inline-start": "",
"inline-end": "",
"block-start": "",
"block-end": "",
},
size: {
sm: "",
md: "",
lg: "",
},
},
compoundVariants: [
{
align: "inline-start",
size: "sm",
class:
"order-first py-1.5 pl-2.5 has-[>button]:ml-[-0.3rem] has-[>kbd]:ml-[-0.15rem]",
},
{
align: "inline-start",
size: "md",
class:
"order-first py-2.5 pl-3 has-[>button]:ml-[-0.3rem] has-[>kbd]:ml-[-0.15rem]",
},
{
align: "inline-start",
size: "lg",
class:
"order-first py-3.5 pl-4 has-[>button]:ml-[-0.3rem] has-[>kbd]:ml-[-0.15rem]",
},
{
align: "inline-end",
size: "sm",
class:
"order-last py-1.5 pr-2.5 has-[>button]:mr-[-0.3rem] has-[>kbd]:mr-[-0.15rem]",
},
{
align: "inline-end",
size: "md",
class:
"order-last py-2.5 pr-3 has-[>button]:mr-[-0.3rem] has-[>kbd]:mr-[-0.15rem]",
},
{
align: "inline-end",
size: "lg",
class:
"order-last py-3.5 pr-4 has-[>button]:mr-[-0.3rem] has-[>kbd]:mr-[-0.15rem]",
},
{
align: "block-start",
size: "sm",
class:
"order-first w-full justify-start px-2.5 pt-2 group-has-[>input]/input-group:pt-2 [.border-b]:pb-2",
},
{
align: "block-start",
size: "md",
class:
"order-first w-full justify-start px-3 pt-2.5 group-has-[>input]/input-group:pt-2.5 [.border-b]:pb-2",
},
{
align: "block-start",
size: "lg",
class:
"order-first w-full justify-start px-4 pt-3.5 group-has-[>input]/input-group:pt-3.5 [.border-b]:pb-2",
},
{
align: "block-end",
size: "sm",
class:
"order-last w-full justify-start px-2.5 pb-2 group-has-[>input]/input-group:pb-2 [.border-t]:pt-2",
},
{
align: "block-end",
size: "md",
class:
"order-last w-full justify-start px-3 pb-2.5 group-has-[>input]/input-group:pb-2 [.border-t]:pt-2",
},
{
align: "block-end",
size: "lg",
class:
"order-last w-full justify-start px-4 pb-3.5 group-has-[>input]/input-group:pb-2 [.border-t]:pt-2",
},
],
},
);
export type InputGroupAddonProps = React.ComponentProps<"div"> & VariantProps<typeof inputGroupAddonVariants>;
function InputGroupAddon({
className,
align = "inline-start",
...props
}: InputGroupAddonProps) {
const { size } = useInputGroup();
return (
<div
role="group"
data-slot="input-group-addon"
data-align={align}
className={cn(inputGroupAddonVariants({ align, size }), 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-xs shadow-none",
{
variants: {
size: {
xs: "h-6 gap-1 rounded-sm px-1.5 [&>svg:not([class*='size-'])]:size-3.5",
sm: "",
"icon-xs": "size-4 rounded-sm p-0 has-[>svg]:p-0",
"icon-sm": "size-6 p-0 has-[>svg]:p-0",
},
},
defaultVariants: {
size: "xs",
},
},
);
export type InputGroupButtonProps = Omit<React.ComponentProps<typeof Button>, "size"> &
VariantProps<typeof inputGroupButtonVariants>;
function InputGroupButton({
className,
type = "button",
variant = "ghost",
size = "xs",
...props
}: InputGroupButtonProps) {
return (
<Button
type={type}
data-size={size}
variant={variant}
size="sm"
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-text-muted [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4",
className,
)}
{...props}
/>
);
}
function InputGroupInput({ className, ...props }: InputProps) {
const { size, variant } = useInputGroup();
return (
<Input
data-slot="input-group-control"
variant={variant}
size={size}
className={cn(
// The group owns the chrome — the control renders bare in every state.
"flex-1 rounded-none border-0 bg-transparent shadow-none ring-0 hover:border-transparent hover:bg-transparent focus-visible:border-transparent focus-visible:bg-transparent focus-visible:ring-0 disabled:bg-transparent aria-invalid:border-transparent aria-invalid:ring-0",
className,
)}
{...props}
/>
);
}
const inputGroupTextareaVariants = cva(
"flex-1 resize-none rounded-none border-0 bg-transparent py-2 shadow-none ring-0 hover:border-transparent hover:bg-transparent focus-visible:border-transparent focus-visible:bg-transparent focus-visible:ring-0 disabled:bg-transparent aria-invalid:border-transparent aria-invalid:ring-0",
{
variants: {
size: {
sm: "px-2.5",
md: "px-3",
lg: "px-4",
},
},
defaultVariants: {
size: "sm",
},
},
);
function InputGroupTextarea({
className,
...props
}: React.ComponentProps<"textarea">) {
const { size } = useInputGroup();
return (
<Textarea
data-slot="input-group-control"
className={cn(inputGroupTextareaVariants({ size }), className)}
{...props}
/>
);
}
export {
InputGroup,
InputGroupAddon,
InputGroupButton,
InputGroupText,
InputGroupInput,
InputGroupTextarea,
inputGroupVariants,
};