Autocomplete

Autocomplete is a component used to display suggestions in response to user text input.

<Autocomplete.Root placeholder="Select a digimon">
  <Autocomplete.Option value="アグモン">アグモン</Autocomplete.Option>
  <Autocomplete.Option value="ガブモン">ガブモン</Autocomplete.Option>
  <Autocomplete.Option value="テントモン">テントモン</Autocomplete.Option>
  <Autocomplete.Option value="ピヨモン">ピヨモン</Autocomplete.Option>
  <Autocomplete.Option value="ゴマモン">ゴマモン</Autocomplete.Option>
  <Autocomplete.Option value="パルモン">パルモン</Autocomplete.Option>
  <Autocomplete.Option value="パタモン">パタモン</Autocomplete.Option>
  <Autocomplete.Option value="テイルモン">テイルモン</Autocomplete.Option>
</Autocomplete.Root>

Usage

import { Autocomplete } from "@yamada-ui/react"

import { Autocomplete } from "@/components/ui"

import { Autocomplete } from "@workspaces/ui"

<Autocomplete.Root>
  <Autocomplete.Group>
    <Autocomplete.Label />
    <Autocomplete.Option />
  </Autocomplete.Group>
</Autocomplete.Root>

Grouping Options

<Autocomplete.Root placeholder="Select a digimon">
  <Autocomplete.Group>
    <Autocomplete.Label>成長期</Autocomplete.Label>
    <Autocomplete.Option value="アグモン">アグモン</Autocomplete.Option>
    <Autocomplete.Option value="ガブモン">ガブモン</Autocomplete.Option>
    <Autocomplete.Option value="テントモン">テントモン</Autocomplete.Option>
    <Autocomplete.Option value="ピヨモン">ピヨモン</Autocomplete.Option>
    <Autocomplete.Option value="ゴマモン">ゴマモン</Autocomplete.Option>
    <Autocomplete.Option value="パルモン">パルモン</Autocomplete.Option>
    <Autocomplete.Option value="パタモン">パタモン</Autocomplete.Option>
    <Autocomplete.Option value="テイルモン">テイルモン</Autocomplete.Option>
  </Autocomplete.Group>

  <Autocomplete.Group label="成熟期">
    <Autocomplete.Option value="グレイモン">グレイモン</Autocomplete.Option>
    <Autocomplete.Option value="ガルルモン">ガルルモン</Autocomplete.Option>
    <Autocomplete.Option value="カブテリモン">カブテリモン</Autocomplete.Option>
    <Autocomplete.Option value="バードラモン">バードラモン</Autocomplete.Option>
    <Autocomplete.Option value="イッカクモン">イッカクモン</Autocomplete.Option>
    <Autocomplete.Option value="トグモン">トグモン</Autocomplete.Option>
    <Autocomplete.Option value="エンジェモン">エンジェモン</Autocomplete.Option>
  </Autocomplete.Group>

  <Autocomplete.Group label="完全体">
    <Autocomplete.Option value="メタルグレイモン">
      メタルグレイモン
    </Autocomplete.Option>
    <Autocomplete.Option value="ワーガルルモン">
      ワーガルルモン
    </Autocomplete.Option>
    <Autocomplete.Option value="アトラーカブテリモン">
      アトラーカブテリモン
    </Autocomplete.Option>
    <Autocomplete.Option value="ガルダモン">ガルダモン</Autocomplete.Option>
    <Autocomplete.Option value="ズドモン">ズドモン</Autocomplete.Option>
    <Autocomplete.Option value="リリモン">リリモン</Autocomplete.Option>
    <Autocomplete.Option value="ホーリーエンジェモン">
      ホーリーエンジェモン
    </Autocomplete.Option>
    <Autocomplete.Option value="エンジェウーモン">
      エンジェウーモン
    </Autocomplete.Option>
  </Autocomplete.Group>

  <Autocomplete.Group label="究極体">
    <Autocomplete.Option value="ウォーグレイモン">
      ウォーグレイモン
    </Autocomplete.Option>
    <Autocomplete.Option value="メタルガルルモン">
      メタルガルルモン
    </Autocomplete.Option>
    <Autocomplete.Option value="ヘラクルカブテリモン">
      ヘラクルカブテリモン
    </Autocomplete.Option>
    <Autocomplete.Option value="ホウオウモン">ホウオウモン</Autocomplete.Option>
    <Autocomplete.Option value="ヴァイクモン">ヴァイクモン</Autocomplete.Option>
    <Autocomplete.Option value="ロゼモン">ロゼモン</Autocomplete.Option>
    <Autocomplete.Option value="ゴッドドラモン">
      ゴッドドラモン
    </Autocomplete.Option>
    <Autocomplete.Option value="ホーリードラモン">
      ホーリードラモン
    </Autocomplete.Option>
  </Autocomplete.Group>
</Autocomplete.Root>

Use items

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "オメガモン", value: "オメガモン" },
    { label: "ディアボロモン", value: "ディアボロモン" },
    {
      items: [
        { label: "アグモン", value: "アグモン" },
        { label: "ガブモン", value: "ガブモン" },
        { label: "テントモン", value: "テントモン" },
        { label: "ピヨモン", value: "ピヨモン" },
        { label: "ゴマモン", value: "ゴマモン" },
        { label: "パルモン", value: "パルモン" },
        { label: "パタモン", value: "パタモン" },
        { label: "テイルモン", value: "テイルモン" },
      ],
      label: "成長期",
    },
    {
      items: [
        { label: "グレイモン", value: "グレイモン" },
        { label: "ガルルモン", value: "ガルルモン" },
        { label: "カブテリモン", value: "カブテリモン" },
        { label: "バードラモン", value: "バードラモン" },
        { label: "イッカクモン", value: "イッカクモン" },
        { label: "トグモン", value: "トグモン" },
        { label: "エンジェモン", value: "エンジェモン" },
      ],
      label: "成熟期",
    },
    {
      items: [
        { label: "メタルグレイモン", value: "メタルグレイモン" },
        { label: "ワーガルルモン", value: "ワーガルルモン" },
        { label: "アトラーカブテリモン", value: "アトラーカブテリモン" },
        { label: "ガルダモン", value: "ガルダモン" },
        { label: "ズドモン", value: "ズドモン" },
        { label: "リリモン", value: "リリモン" },
        { label: "ホーリーエンジェモン", value: "ホーリーエンジェモン" },
        { label: "エンジェウーモン", value: "エンジェウーモン" },
      ],
      label: "完全体",
    },
    {
      items: [
        { label: "ウォーグレイモン", value: "ウォーグレイモン" },
        { label: "メタルガルルモン", value: "メタルガルルモン" },
        { label: "ヘラクルカブテリモン", value: "ヘラクルカブテリモン" },
        { label: "ホウオウモン", value: "ホウオウモン" },
        { label: "ヴァイクモン", value: "ヴァイクモン" },
        { label: "ロゼモン", value: "ロゼモン" },
        { label: "ゴッドドラモン", value: "ゴッドドラモン" },
        { label: "ホーリードラモン", value: "ホーリードラモン" },
      ],
      label: "究極体",
    },
  ],
  [],
)

return <Autocomplete.Root items={items} placeholder="Select a digimon" />

Use Query

const items = useMemo<Autocomplete.Item[]>(
  () => [
    {
      label: (
        <>
          <Text as="span" flex="1">
            アグモン
          </Text>
          <HeartIcon fontSize="lg" />
        </>
      ),
      query: "アグモン",
      value: "アグモン",
    },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return <Autocomplete.Root items={items} placeholder="Select a digimon" />

Change Variants

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <VStack>
    <For each={["outline", "filled", "flushed"]}>
      {(variant) => (
        <Autocomplete.Root
          key={variant}
          variant={variant}
          placeholder={toTitleCase(variant)}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Change Sizes

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <VStack>
    <For each={["xs", "sm", "md", "lg", "xl"]}>
      {(size) => (
        <Autocomplete.Root
          key={size}
          size={size}
          placeholder={`Size: ${size}`}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Set Default Value

To set a default value, specify a value for defaultValue.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    defaultValue="アグモン"
    placeholder="Select a digimon"
    items={items}
  />
)

Set Default Input Value

To set a default input value, specify a string for defaultInputValue.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    defaultInputValue="モン"
    openOnFocus
    placeholder="Select a digimon"
    items={items}
  />
)

Enable Multiple Selection

To enable multiple selection, set multiple to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return <Autocomplete.Root multiple placeholder="Select digimon" items={items} />

Limit Maximum Selections

To limit the maximum number of selections, specify a number for max.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    items={items}
    multiple
    max={3}
    placeholder="Select digimon"
  />
)

Change Separator

To change the separator, specify a string for separator. By default, , is set.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    items={items}
    multiple
    placeholder="Select digimon"
    separator=";"
  />
)

Allow Custom Value

To allow input of value not in the list, set allowCustomValue to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    allowCustomValue
    placeholder="Select a digimon"
    items={items}
    onChange={(value) => console.log("value:", value)}
  />
)

Change Offset

To change the offset, specify a value for gutter or offset.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root items={items} placeholder="Select a digimon" gutter={16} />
)

Change Animation

To change the animation, specify "block-start" or "inline-end" for animationScheme. By default, "scale" is set.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <VStack>
    <For
      each={["scale", "block-end", "block-start", "inline-end", "inline-start"]}
    >
      {(animationScheme) => (
        <Autocomplete.Root
          key={animationScheme}
          items={items}
          animationScheme={animationScheme}
          placeholder={toTitleCase(animationScheme)}
        />
      )}
    </For>
  </VStack>
)

Change Placement

To change the placement, specify "start" or "end-end" for placement. By default, "end" is set.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    animationScheme="inline-start"
    items={items}
    placeholder="Select a digimon"
  />
)

Blocking Scroll

To block scrolling, set blockScrollOnMount to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    items={items}
    blockScrollOnMount
    placeholder="Select a digimon"
  />
)

To open the dropdown on focus, set openOnFocus to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root openOnFocus placeholder="Select a digimon" items={items} />
)

To close the dropdown on scroll, set closeOnScroll to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    closeOnScroll
    items={items}
    placeholder="Select a digimon"
  />
)

To handle the event of opening the dropdown on change, set a function to openOnChange.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)
return (
  <Autocomplete.Root
    items={items}
    openOnChange={(ev) => ev.target.value.length > 2}
    placeholder="Select a digimon"
  />
)

To handle the event of closing the dropdown on change, set a function to closeOnChange.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    closeOnChange={(ev) => !ev.target.value.length}
    items={items}
    placeholder="Select a digimon"
  />
)

To disable opening the dropdown on click, set openOnClick to false.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    items={items}
    openOnClick={false}
    placeholder="Select a digimon"
  />
)

Disable Focus After Clear

To disable focus after clear, set focusOnClear to false.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    defaultValue="アグモン"
    focusOnClear={false}
    items={items}
    placeholder="Select a digimon"
  />
)

Disable Close On Select

To disable closing the dropdown on select, set closeOnSelect to false.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { closeOnSelect: true, label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    closeOnSelect={false}
    items={items}
    placeholder="Select a digimon"
  />
)

Disable Close On Outside Click

To disable closing dropdown when clicking outside, set closeOnBlur to false.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    closeOnBlur={false}
    items={items}
    placeholder="Select a digimon"
  />
)

Disable Close On Esc

To disable closing the dropdown with the Esc key, set closeOnEsc to false.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    closeOnEsc={false}
    items={items}
    placeholder="Select a digimon"
  />
)

Disable Clear Button

To disable the clear button, set clearable to false.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    clearable={false}
    items={items}
    placeholder="Select a digimon"
  />
)

Disable Options

To disable specific options, set disabled to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { disabled: true, label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return <Autocomplete.Root items={items} placeholder="Select a digimon" />

Disable

To disable, set disabled to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <VStack>
    <For each={["outline", "filled", "flushed"]}>
      {(variant) => (
        <Autocomplete.Root
          variant={variant}
          disabled
          placeholder={toTitleCase(variant)}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Read-Only

To make read-only, set readOnly to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <VStack>
    <For each={["outline", "filled", "flushed"]}>
      {(variant) => (
        <Autocomplete.Root
          variant={variant}
          readOnly
          placeholder={toTitleCase(variant)}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Invalid

To make invalid, set invalid to true.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <VStack>
    <For each={["outline", "filled", "flushed"]}>
      {(variant) => (
        <Autocomplete.Root
          variant={variant}
          invalid
          placeholder={toTitleCase(variant)}
          items={items}
        />
      )}
    </For>
  </VStack>
)

Change Border Color

To customize focus and error border colors, set colors for focusBorderColor or errorBorderColor.

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <VStack>
    <Autocomplete.Root
      focusBorderColor="green.500"
      items={items}
      placeholder="Custom border color"
    />

    <Autocomplete.Root
      errorBorderColor="orange.500"
      invalid
      items={items}
      placeholder="Custom border color"
    />
  </VStack>
)

Customize Empty Message

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    emptyMessage="You just hit a route that doesn't exist... the sadness.😢"
    items={items}
    placeholder="Select a digimon"
  />
)

Customize Icons

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <VStack>
    <Autocomplete.Root
      placeholder="Select a digimon"
      iconProps={{ color: "orange" }}
      items={items}
    />

    <Autocomplete.Root
      icon={<ChevronsDownIcon />}
      placeholder="Select a digimon"
      items={items}
    />
  </VStack>
)

Customize Option Icons

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    items={items}
    placeholder="Select a digimon"
    optionProps={{ icon: <BugIcon /> }}
  />
)

Customize Multiple Selection Display

const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    items={items}
    multiple
    placeholder="Select a character"
    render={({ label, onClear }) => (
      <Tag size="sm" me="{gap}" onClose={onClear}>
        {label}
      </Tag>
    )}
  />
)

Control

const [value, setValue] = useState<string>("アグモン")
const items = useMemo<Autocomplete.Item[]>(
  () => [
    { label: "アグモン", value: "アグモン" },
    { label: "ガブモン", value: "ガブモン" },
    { label: "テントモン", value: "テントモン" },
    { label: "ピヨモン", value: "ピヨモン" },
    { label: "ゴマモン", value: "ゴマモン" },
    { label: "パルモン", value: "パルモン" },
    { label: "パタモン", value: "パタモン" },
    { label: "テイルモン", value: "テイルモン" },
  ],
  [],
)

return (
  <Autocomplete.Root
    value={value}
    onChange={setValue}
    items={items}
    placeholder="Select a digimon"
  />
)

If you use this code, you need to add "use client" to the top of the file.

Props

Autocomplete.Root

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"outline"`	`"filled" \| "flushed" \| "outline" \| "plain"` The variant of the component.
`allowCustomValue`	`false`	`boolean` If `true`, the autocomplete will allow custom value.
`animationScheme`	`"scale"`	`"scale" \| "none" \| SimplePlacement` The animation of the element.
`autoUpdate`	`true`	`boolean` If `true`, automatically updates the position of the floating element when necessary.
`blockScrollOnMount`	`false`	`boolean` If `true`, scrolling will be disabled on the `body` when the modal opens.
`clearable`	`true`	`boolean` If `true`, display the clear icon.
`clearIcon`	-	`ReactNode` The icon to be used in the clear button.
`closeOnBlur`	`true`	`boolean` If `true`, the popover will close when you blur out it by clicking outside or tabbing out.
`closeOnChange`	`false`	`((ev: ChangeEvent<HTMLInputElement>) => boolean) \| boolean` If `true`, the autocomplete will be closed when the input value changes.
`closeOnEsc`	`true`	`boolean` If `true`, the popover will hide on pressing Esc key.
`closeOnScroll`	`false`	`boolean` If `true`, the popover will hide on scroll.
`closeOnSelect`	`true`	`boolean` If `true`, the list element will be closed when value is selected.
`contentProps`	-	`AutocompleteContentProps` Props for content element.
`defaultInputValue`	-	`string` The initial value of the input.
`defaultOpen`	-	`boolean` If `true`, the element will be initially opened.
`defaultValue`	-	`Multiple extends true ? string[] : string` The initial value of the autocomplete.
`disabled`	`false`	`boolean` If `true`, the combobox will be disabled.
`duration`	`0.2`	`number \| MotionLifecycleProps<number>` The animation duration.
`elementProps`	-	`InputGroup.ElementProps` The props for the end element.
`elements`	-	`{ floating?: HTMLElement \| null \| undefined; reference?: HTMLButtonElement \| null \| undefined }` Object containing the reference and floating elements.
`emptyIcon`	-	`ReactNode` The icon to be used in the empty element.
`emptyMessage`	`"No results found"`	`ReactNode` The message displayed when the search yields no hits.
`emptyProps`	-	`AutocompleteEmptyProps` Props for empty element.
`errorBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is invalid.
`filter`	-	`AutocompleteFilter` The function to filter the items.
`flip`	`true`	`boolean` If `true`, the popper will change its placement and flip when it's about to overflow its boundary area.
`focusBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is focused.
`focusOnClear`	`true`	`boolean` If `true`, the input will be focused when the clear icon is clicked.
`groupProps`	-	`Omit<AutocompleteGroupProps, "children" \| "label">` Props for group element.
`gutter`	`8`	`number` The distance or margin between the reference and popper. It is used internally to create an `offset` modifier.
`icon`	-	`ReactNode` The icon to be used in the autocomplete.
`iconProps`	-	`AutocompleteIconProps` Props for icon element.
`inputProps`	-	`HTMLStyledProps<"input">` The props for the input element.
`inputValue`	-	`string` The value of the input.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`items`	`[]`	`ComboboxItem[]` If provided, generate options based on items.
`matcher`	-	`AutocompleteMatcher` The function to match the items.
`matchWidth`	`false`	`boolean` If `true`, the popper will match the width of the reference at all times. It's useful for `autocomplete`, `date-picker` and `select` patterns.
`max`	-	`number` The maximum selectable value.
`middleware`	-	`(false \| { name: string; options?: any; fn: (state: { x: number; y: number; placement: Placement; platform: Platform; strategy: Strategy; initialPlacement: Placement; middlewareData: MiddlewareData; rects: ElementRects; elements: Elements; }) => Promisable<...>; } \| null \| undefined)[]` Array of middleware objects to modify the positioning or provide data for rendering.
`multiple`	`false`	`Multiple` If `true`, the autocomplete will be multiple.
`offset`	-	`[number, number]` The main and cross-axis offset to displace popper element from its reference element.
`onChange`	-	`(value: Multiple extends true ? string[] : string) => void` The callback invoked when value state changes.
`onClose`	-	`() => void \| Promise<void>` Callback invoked to close the element.
`onInputChange`	-	`(value: string) => void` The callback invoked when input value state changes.
`onOpen`	-	`() => void \| Promise<void>` Callback invoked to open the element.
`open`	-	`boolean` If `true`, the element will be opened.
`openOnChange`	`true`	`((ev: ChangeEvent<HTMLInputElement>) => boolean) \| boolean` If `true`, the autocomplete will be opened when the input value changes.
`openOnClick`	`true`	`boolean` If `true`, the combobox will be opened when click on the field.
`openOnEnter`	`true`	`boolean` If `true`, the combobox will be opened when enter is pressed.
`openOnFocus`	`false`	`boolean` If `true`, the autocomplete will be opened when the input is focused.
`openOnSpace`	`true`	`boolean` If `true`, the combobox will be opened when space is pressed.
`optionProps`	-	`Omit<AutocompleteOptionProps, "children" \| "value">` Props for option element.
`placeholder`	-	`string` The placeholder for autocomplete.
`placement`	`"end"`	`Direction` The placement of the popper relative to its reference.
`platform`	-	`Platform` Custom or extended platform object.
`preventOverflow`	`true`	`boolean` If `true`, will prevent the popper from being cut off and ensure it's visible within the boundary area.
`readOnly`	`false`	`boolean` If `true`, the combobox will be readonly.
`render`	-	`(props: AutocompleteRenderProps) => ReactNode` The function to render the selected items.
`required`	`false`	`boolean` If `true`, the field will be required.
`rootProps`	-	`InputGroup.RootProps` Props for root element.
`selectFocusRef`	-	`RefObject<HTMLElement \| null>` The `ref` of the element that should receive focus when selected.
`selectOnSpace`	`true`	`boolean` If `true`, the item will be selected when space is pressed.
`separator`	`","`	`string` The visual separator between each value.
`strategy`	`"absolute"`	`Strategy` The CSS positioning strategy to use.
`value`	-	`Multiple extends true ? string[] : string` The value of the autocomplete.
`whileElementsMounted`	-	`(reference: HTMLButtonElement, floating: HTMLElement, update: () => void) => () => void` A callback invoked when both the reference and floating elements are mounted, and cleaned up when either is unmounted. This is useful for setting up event listeners (e.g. pass `autoUpdate`).

Autocomplete.Group

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`label`	-	`ReactNode` The label of the group.
`labelProps`	-	`AutocompleteLabelProps` Props for the label component.

Autocomplete.Label

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

Autocomplete.Option

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`closeOnSelect`	-	`boolean` If `true`, the item will be closed when selected.
`disabled`	`false`	`boolean` If `true`, the item will be disabled.
`icon`	-	`ReactNode` The icon to be used in the autocomplete option.
`selected`	-	`boolean` If `true`, the item will be selected.
`value`	-	`string` The value of the item.

Accessibility

Currently, this section is being updated due to the migration of v2.