For the complete documentation index, see llms.txt. Markdown variants are available by appending .md to documentation URLs. Homepage markdown is available at /llms.md/content.md. An agent skill is available at /.well-known/agent-skills/site-skill.md.

Input Group

The Input Group component from this design system, built on Base UI.

Installation

$ pnpm dlx shadcn@latest add @cobalt/input-group

Options

  • <InputGroup variant="muted"> borderless pill on the sunken surface with subtle text, for search fields in dashboard toolbars. Set the height and width on the group.
  • <InputGroupButton variant="tonal"> fills the button with a 10% foreground tint (20% in dark mode).

Source

"use client";

import { cva } from "class-variance-authority";
import type { VariantProps } from "class-variance-authority";
import { cn } from "cn";
import * as React from "react";

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

function InputGroup({
  className,
  shape = "default",
  variant = "default",
  ...props
}: React.ComponentProps<"div"> & {
  shape?: "default" | "pill";
  variant?: "default" | "muted";
}) {
  return (
    <div
      data-slot="input-group"
      data-shape={shape}
      data-variant={variant}
      role="group"
      className={cn(
        "group/input-group relative flex h-9 w-full min-w-0 items-center outline-none 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",
        shape === "default" &&
          // cobalt-allow-focus-within -- text input (input group)
          "rounded-[10px] bg-[var(--surface-strong,var(--muted))] text-muted-foreground ring-2 ring-transparent ring-inset transition-[background-color,box-shadow,color] duration-150 ease-[ease] motion-reduce:transition-none hover:not-focus-within:not-has-[[data-slot=input-group-control]:disabled]:not-has-[[aria-invalid=true]]:ring-[var(--border-hover,var(--border))] focus-within:not-has-[[data-slot=input-group-control]:disabled]:not-has-[[aria-invalid=true]]:ring-[var(--foreground-subtle,var(--ring))] has-[[data-slot=input-group-control]:disabled]:cursor-not-allowed has-[[data-slot=input-group-control]:disabled]:bg-[var(--input-disabled-surface,var(--muted))] has-[[aria-invalid=true]]:bg-[var(--input-invalid-surface,color-mix(in_srgb,var(--destructive)_15%,transparent))]",
        shape === "pill" &&
          "h-13 rounded-full border border-transparent bg-popover px-1 shadow-xl ring-1 ring-foreground/5 transition-[color,box-shadow] has-[[data-slot=input-group-control]:focus-visible]:border-transparent has-[[data-slot=input-group-control]:focus-visible]:ring-2 has-[[data-slot=input-group-control]:focus-visible]:ring-ring/30 dark:bg-popover dark:shadow-none motion-reduce:transition-none",
        variant === "muted" &&
          "rounded-full border-transparent bg-[var(--surface-sunken,var(--muted))] text-[color:var(--foreground-subtle,var(--muted-foreground))] shadow-none hover:not-focus-within:not-has-[[data-slot=input-group-control]:disabled]:not-has-[[aria-invalid=true]]:ring-transparent dark:bg-[var(--surface-sunken,var(--muted))] [&_input]:placeholder:text-[color:var(--foreground-subtle,var(--muted-foreground))]",
        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-has-[[data-slot=input-group-control]:disabled]/input-group:text-[color:var(--input-disabled-foreground,var(--muted-foreground))] group-has-[[aria-invalid=true]]/input-group:text-[color:var(--input-invalid-placeholder,var(--destructive))] [&>kbd]:rounded-[4px] [&>svg:not([class*='size-'])]:size-5 group-data-[shape=pill]/input-group:[&>svg:not([class*='size-'])]:size-4",
  {
    defaultVariants: {
      align: "inline-start",
    },
    variants: {
      align: {
        "block-end":
          "order-last w-full justify-start px-2.5 pb-2 group-has-[>input]/input-group:pb-2 [.border-t]:pt-2",
        "block-start":
          "order-first w-full justify-start px-2.5 pt-2 group-has-[>input]/input-group:pt-2 [.border-b]:pb-2",
        "inline-end":
          "order-last pr-2 has-[>button]:-mr-1 has-[>kbd]:mr-[-0.15rem]",
        "inline-start":
          "order-first pl-2 has-[>button]:-ml-1 has-[>kbd]:ml-[-0.15rem]",
      },
    },
  }
);

function InputGroupAddon({
  className,
  align = "inline-start",
  ...props
}: React.ComponentProps<"div"> & VariantProps<typeof inputGroupAddonVariants>) {
  return (
    // Click-to-focus is a mouse convenience (official shadcn pattern). The input
    // is already reachable by keyboard, so a key handler would add nothing.
    // oxlint-disable-next-line jsx-a11y/click-events-have-key-events
    <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",
  {
    defaultVariants: {
      shape: "default",
      size: "xs",
    },
    variants: {
      shape: {
        default: "",
        pill: "rounded-full",
      },
      size: {
        icon: "size-9 p-0 has-[>svg]:p-0",
        "icon-sm": "size-8 p-0 has-[>svg]:p-0",
        "icon-xs": "size-6 rounded-[4px] p-0 has-[>svg]:p-0",
        sm: "",
        xs: "h-6 gap-1 rounded-[4px] px-1.5 [&>svg:not([class*='size-'])]:size-3.5",
      },
    },
  }
);

function InputGroupButton({
  className,
  type = "button",
  variant = "ghost",
  size = "xs",
  shape = "default",
  ...props
}: Omit<React.ComponentProps<typeof Button>, "size" | "type" | "variant"> &
  VariantProps<typeof inputGroupButtonVariants> & {
    type?: "button" | "submit" | "reset";
    variant?: React.ComponentProps<typeof Button>["variant"] | "tonal";
  }) {
  const tonal = variant === "tonal";
  return (
    <Button
      type={type}
      data-size={size}
      variant={tonal ? "ghost" : variant}
      className={cn(
        inputGroupButtonVariants({ shape, size }),
        tonal &&
          "bg-foreground/10 text-foreground hover:bg-foreground/15 aria-expanded:bg-foreground/15 dark:bg-foreground/20 dark:hover:bg-foreground/25",
        className
      )}
      {...props}
    />
  );
}

function InputGroupText({ className, ...props }: React.ComponentProps<"span">) {
  return (
    <span
      className={cn(
        "flex items-center gap-2 text-sm text-muted-foreground group-has-[[data-slot=input-group-control]:disabled]/input-group:text-[color:var(--input-disabled-foreground,var(--muted-foreground))] group-has-[[aria-invalid=true]]/input-group:text-[color:var(--input-invalid-placeholder,var(--destructive))] [&_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 hover:!ring-0 focus:!ring-0 focus-visible:ring-0 disabled:bg-transparent aria-invalid:bg-transparent aria-invalid:ring-0 dark: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 hover:!ring-0 focus:!ring-0 focus-visible:ring-0 disabled:bg-transparent aria-invalid:bg-transparent aria-invalid:ring-0 dark:bg-transparent",
        className
      )}
      {...props}
    />
  );
}

export {
  InputGroup,
  InputGroupAddon,
  InputGroupButton,
  InputGroupText,
  InputGroupInput,
  InputGroupTextarea,
};