Components

Autocomplete

Free-text input with search-as-you-type suggestions.

Country

Type to filter countries

Composition

Free-text suggestions

AutocompleteInput includes its clear button.

<Autocomplete>
- <AutocompleteInput />
- <AutocompleteContent>
  - <AutocompleteEmpty />
  - <AutocompleteList>
    - <AutocompleteGroup>
      - <AutocompleteGroupLabel />
      - <AutocompleteItem />
      </AutocompleteGroup>
    </AutocompleteList>
  </AutocompleteContent>
</Autocomplete>

Separate clear action

<Autocomplete>
- <AutocompleteInput />
- <AutocompleteClear />
</Autocomplete>

Installation

The Control UI source installs this primitive from src/registry/sources/control-ui/ui/autocomplete.tsx.

Registry command

npx shadcn@latest add https://control-ui.dev/r/autocomplete.json

See registry manifest

Dependencies

Surface variantssrc/registry/sources/control-ui/surface-variants.tsSupport

Control variantssrc/registry/sources/control-ui/control-variants.tsSupport

Scroll areascroll-areaPrimitive

Raw code

Primary installed source

src/registry/sources/control-ui/ui/autocomplete.tsx

"use client";

import { Autocomplete as AutocompletePrimitive } from "@base-ui/react/autocomplete";

import type { ComponentProps, CSSProperties, ReactNode } from "react";

import type { OpenChangeEventDetails } from "@/components/control-ui/control-props";

import type { ControlSize } from "@/components/control-ui/control-variants";

import type { FieldKnobStyle } from "@/components/control-ui/knob-contracts/field-knobs";

import type { PopupKnobStyle } from "@/components/control-ui/knob-contracts/popup-knobs";

import { cn } from "@/components/control-ui/lib/cn";

import { controlEffectsAttribute } from "@/components/control-ui/skin";

import { useSkin } from "@/components/control-ui/skin-provider";

import { popupItemStructureClasses } from "@/components/control-ui/surface-variants";

import { ScrollArea } from "@/components/control-ui/ui/scroll-area";

export type AutocompleteProps<Value = string> = {

children?: ReactNode;

items?: readonly Value[];

value?: string;

defaultValue?: string;

onValueChange?: (value: string) => void;

open?: boolean;

defaultOpen?: boolean;

onOpenChange?: (open: boolean, eventDetails: OpenChangeEventDetails) => void;

disabled?: boolean;

readOnly?: boolean;

required?: boolean;

name?: string;

mode?: "list" | "both" | "inline" | "none";

autoHighlight?: boolean | "always";

limit?: number;

openOnInputClick?: boolean;

filter?: ((itemValue: Value, query: string, itemToString?: (itemValue: Value) => string) => boolean) | null;

itemToStringValue?: (itemValue: Value) => string;

};

export type AutocompleteInputProps = Omit<Omit<ComponentProps<"input">, "size">, "style"> & { style?: CSSProperties & FieldKnobStyle } & {

size?: ControlSize;

};

export type AutocompleteClearProps = ComponentProps<"button"> & { style?: CSSProperties & FieldKnobStyle };

export type AutocompleteContentProps = Omit<

ComponentProps<"div"> & {

sideOffset?: number;

},

"style"

> & { style?: CSSProperties & PopupKnobStyle };

export type AutocompleteListProps<Value = unknown> = Omit<ComponentProps<"div">, "children"> & {

children?: ReactNode | ((item: Value, index: number) => ReactNode);

} & { style?: CSSProperties & PopupKnobStyle };

export type AutocompleteItemProps<Value = unknown> = Omit<

Omit<ComponentProps<"div">, "value"> & {

value?: Value;

disabled?: boolean;

},

"style"

> & { style?: CSSProperties & PopupKnobStyle };

export type AutocompleteEmptyProps = Omit<ComponentProps<"div">, "style"> & { style?: CSSProperties & FieldKnobStyle };

export type AutocompleteGroupProps = ComponentProps<"div"> & { style?: CSSProperties & FieldKnobStyle };

export type AutocompleteGroupLabelProps = Omit<ComponentProps<"div">, "style"> & { style?: CSSProperties & PopupKnobStyle };

export function Autocomplete<Value = string>({ children, autoHighlight = true, ...props }: AutocompleteProps<Value>) {

return (

<AutocompletePrimitive.Root autoHighlight={autoHighlight} {...props}>

{children}

</AutocompletePrimitive.Root>

);

}

export function AutocompleteClear({ className, children, ...props }: AutocompleteClearProps) {

return (

<AutocompletePrimitive.Clear

data-control-ui="autocomplete"

data-control-family="field"

data-field-kind="autocomplete"

data-slot="clear"

aria-label="Clear search"

      className={cn("inline-flex size-6 shrink-0 cursor-pointer items-center justify-center disabled:cursor-not-allowed", className)}

{...props}

>

{children ?? (

<svg viewBox="0 0 12 12" className="size-3" aria-hidden="true" fill="none">

          <path d="M3 3 9 9M9 3 3 9" stroke="currentColor" strokeWidth="1.3" strokeLinecap="round" strokeLinejoin="round" />

</svg>

)}

</AutocompletePrimitive.Clear>

);

}

export function AutocompleteInput({ size = "md", className, ...props }: AutocompleteInputProps) {

return (

<AutocompletePrimitive.InputGroup

data-control-ui="autocomplete"

data-field-kind="autocomplete"

data-slot="root"

className="relative flex w-full items-center"

>

<AutocompletePrimitive.Input

data-control-ui="autocomplete"

data-field-kind="autocomplete"

data-slot="input"

data-control="true"

data-control-family="field"

data-size={size}

className={cn("w-full min-w-0 disabled:cursor-not-allowed", className)}

{...props}

/>

<AutocompleteClear className="absolute end-1.5 top-1/2 -translate-y-1/2" />

</AutocompletePrimitive.InputGroup>

);

}

export function AutocompleteContent({ className, children, sideOffset = 6, ...props }: AutocompleteContentProps) {

const skin = useSkin();

return (

<AutocompletePrimitive.Portal>

<AutocompletePrimitive.Positioner

data-control-ui="autocomplete"

data-popup-kind="autocomplete"

data-control-family="popup"

data-slot="positioner"

data-skin={skin.id}

data-effects={controlEffectsAttribute(skin.effects)}

side="bottom"

align="start"

sideOffset={sideOffset}

className="z-(--z-popup)"

>

<AutocompletePrimitive.Popup

data-control-ui="autocomplete"

data-popup-kind="autocomplete"

data-control-family="popup"

data-slot="content"

data-surface="floating"

data-popup-part="list-surface"

className={cn("w-[var(--anchor-width)] max-w-[var(--available-width)]", className)}

{...props}

>

{children}

</AutocompletePrimitive.Popup>

</AutocompletePrimitive.Positioner>

</AutocompletePrimitive.Portal>

);

}

export function AutocompleteList<Value = unknown>({ className, children, ...props }: AutocompleteListProps<Value>) {

return (

    <ScrollArea className="w-full" viewportClassName="overscroll-y-contain" maxHeight="min(18rem, var(--available-height))" lockAxis="x">

<AutocompletePrimitive.List

data-control-ui="autocomplete"

data-popup-kind="autocomplete"

data-slot="list"

data-control-family="popup"

data-popup-part="list-content"

className={className}

{...props}

>

{children}

</AutocompletePrimitive.List>

</ScrollArea>

);

}

export function AutocompleteEmpty({ className, children, ...props }: AutocompleteEmptyProps) {

return (

<AutocompletePrimitive.Empty

data-control-ui="autocomplete"

data-control-family="popup"

data-popup-kind="autocomplete"

data-slot="empty"

className={cn("px-[calc(var(--padding-x)*0.5)] empty:h-0 empty:overflow-hidden empty:p-0", className)}

{...props}

>

{children}

</AutocompletePrimitive.Empty>

);

}

export function AutocompleteItem<Value = unknown>({ className, children, disabled, ...props }: AutocompleteItemProps<Value>) {

return (

<AutocompletePrimitive.Item

data-control-ui="autocomplete"

data-popup-kind="autocomplete"

data-control-family="popup"

data-slot="item"

data-popup-part="item"

disabled={disabled}

className={cn(popupItemStructureClasses, className)}

{...props}

>

<span

data-control-ui="autocomplete"

data-control-family="popup"

data-popup-kind="autocomplete"

data-slot="item-text"

className="flex min-w-0 flex-1 items-center truncate"

>

{children}

</span>

</AutocompletePrimitive.Item>

);

}

export function AutocompleteGroup({ className, children, ...props }: AutocompleteGroupProps) {

return (

<AutocompletePrimitive.Group

data-control-ui="autocomplete"

data-control-family="field"

data-field-kind="autocomplete"

data-slot="group"

className={className}

{...props}

>

{children}

</AutocompletePrimitive.Group>

);

}

export function AutocompleteGroupLabel({ className, children, ...props }: AutocompleteGroupLabelProps) {

return (

<AutocompletePrimitive.GroupLabel

data-control-ui="autocomplete"

data-popup-kind="autocomplete"

data-slot="group-label"

data-control-family="popup"

data-popup-part="label"

className={cn("px-[calc(var(--padding-x)*0.5)]", className)}

{...props}

>

{children}

</AutocompletePrimitive.GroupLabel>

);

}

Knobs

Typed custom properties the recipe paints with. Set one on the root — style, a utility class, or a skin — and every slot inherits it.

--cui-field-* · 15 knobsHow the cascade resolves

--cui-field-radius<length-percentage>var(--nest-radius, var(--radius-control))

--cui-field-background<color>var(--control-fill)

--cui-field-hover-background<color>var(--hover-fill)

--cui-field-affordance-background<color>transparent

--cui-field-affordance-shadow*0 0 transparent

--cui-field-affordance-foreground<color>var(--muted-foreground)

--cui-field-affordance-hover-background<color>var(--hover-fill)

--cui-field-foreground<color>var(--foreground)

--cui-field-border-color<color>var(--control-rim)

--cui-field-border-width<length>var(--control-rim-width)

--cui-field-shadow*var(--shadow-inset)

--cui-field-backdrop-filter*blur(0px)

--cui-field-height<length-percentage>var(--control-h-md)

--cui-field-padding-inline<length-percentage>var(--padding-x)

--cui-field-font-size<length-percentage>var(--text-body)

--cui-popup-* · 44 knobsHow the cascade resolves

--cui-popup-title-foreground<color>var(--cui-popup-foreground)

--cui-popup-title-font-size<length-percentage>var(--text-heading-3)

--cui-popup-title-font-weight<number>var(--font-weight-semibold)

--cui-popup-title-line-height<number>var(--text-heading-3--line-height)

--cui-popup-title-letter-spacing<length>-0.025em

--cui-popup-description-foreground<color>var(--muted-foreground)

--cui-popup-close-inset<length-percentage>calc(var(--spacing) * 3)

--cui-popup-item-inset<length-percentage>calc(var(--spacing) * 8)

--cui-popup-label-padding-block<length-percentage>var(--cui-popup-item-padding-block)

--cui-popup-label-padding-inline<length-percentage>var(--cui-popup-item-padding-inline)

--cui-popup-label-font-size<length-percentage>var(--text-micro)

--cui-popup-label-font-weight<number>var(--font-weight-medium)

--cui-popup-label-letter-spacing<length>0.08em

--cui-popup-label-text-transformnone | uppercase | lowercase | capitalizeuppercase

--cui-popup-separator-inset<length-percentage>calc(var(--popover-padding) * -1)

--cui-popup-shortcut-font-size<length-percentage>var(--text-body)

--cui-popup-shortcut-letter-spacing<length>0.02em

--cui-popup-status-success-foreground<color>var(--success-text)

--cui-popup-status-warning-foreground<color>var(--warning-text)

--cui-popup-status-info-foreground<color>var(--info-text)

--cui-popup-status-error-foreground<color>var(--destructive)

--cui-popup-radius<length-percentage>var(--radius-popover)

--cui-popup-background<color>var(--popover)

--cui-popup-foreground<color>var(--popover-foreground)

--cui-popup-border-color<color>var(--control-rim)

--cui-popup-border-width<length>var(--control-rim-width)

--cui-popup-shadow*var(--shadow-pop)

--cui-popup-backdrop-filter*blur(var(--backdrop-blur-popover))

--cui-popup-backdrop-background<color>oklch(from var(--foreground) l c h / var(--overlay-opacity))

--cui-popup-backdrop-blur<length>var(--backdrop-blur-overlay)

--cui-popup-item-radius<length-percentage>var(--radius-popup-item-fit)

--cui-popup-item-font-size<length-percentage>var(--text-body)

--cui-popup-item-icon-size<length-percentage>1rem

--cui-popup-item-padding-block<length-percentage>calc(var(--spacing) * 1)

--cui-popup-item-padding-inline<length-percentage>calc(var(--padding-x) * 0.5)

--cui-popup-item-min-height<length-percentage>max(var(--target-min), var(--control-h-xs))

--cui-popup-item-highlight-shadow*inset 0 0 0 1px oklch(from var(--foreground) l c h / 0.35)

--cui-popup-item-foreground<color>var(--foreground)

--cui-popup-item-highlight-background<color>var(--hover-fill)

--cui-popup-item-highlight-foreground<color>var(--cui-popup-item-foreground)

--cui-popup-item-highlight-muted-foreground<color>var(--muted-foreground)

--cui-popup-item-disabled-opacity<number>var(--disabled-opacity)

--cui-popup-separator-color<color>var(--border)

--cui-popup-shortcut-foreground<color>var(--muted-foreground)