Preview

Installation

npx sigma-ui@latest add autocomplete

Usage

<script setup lang="ts">
import {
  Autocomplete,
  AutocompleteAnchor,
  AutocompleteEmpty,
  AutocompleteInput,
  AutocompleteItem,
  AutocompleteList,
} from '@/components/ui/autocomplete';
</script>

<template>
  <Autocomplete v-model="value" open-on-focus>
    <AutocompleteAnchor>
      <AutocompleteInput placeholder="Search fruit..." />
    </AutocompleteAnchor>
    <AutocompleteList>
      <AutocompleteEmpty>No fruit found.</AutocompleteEmpty>
      <AutocompleteItem value="Apple">
        Apple
      </AutocompleteItem>
    </AutocompleteList>
  </Autocomplete>
</template>

v-model is the input text. Items stay visible while their value matches that text. Set open-on-focus to show the list when the field is focused.

Autocomplete or Combobox

Use Autocomplete when any text is a valid answer and the options are only suggestions, such as a search field or a city name. The value is the typed string. Use Combobox when the value must be one of the options. There, typing only filters the list.

Examples

Fruits

API Reference

Autocomplete

Props

Prop	Type	Default
modelValue The controlled value of the Autocomplete (the input text). Can be bound with v-model.	string	-
defaultValue The value of the autocomplete when initially rendered. Use when you do not need to control the state.	string	-
open The controlled open state of the Autocomplete. Can be bound with v-model:open.	boolean	-
defaultOpen The open state of the autocomplete when it is initially rendered. Use when you do not need to control its open state.	boolean	-
disabled When true, prevents the user from interacting with autocomplete	boolean	-
dir The reading direction of the autocomplete when applicable.	Direction	-
name The name of the field. Submitted with its owning form as part of a name/value pair.	string	-
required When true, indicates that the user must set the value before the owning form can be submitted.	boolean	-
resetSearchTermOnBlur Whether to reset the searchTerm when the Autocomplete input blurred	boolean	`false`
openOnFocus Whether to open the autocomplete when the input is focused	boolean	`false`
openOnClick Whether to open the autocomplete when the input is clicked	boolean	`false`
ignoreFilter When true, disable the default filters	boolean	-
highlightOnHover When true, hover over item will trigger highlight	boolean	-
loop When true, keyboard navigation will loop from last item to first, and vice versa.	boolean	-
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"

Events

Event	Payload
update:modelValue Event handler called when the value changes.	[value: string]
update:open Event handler called when the open state of the autocomplete changes.	[value: boolean]
highlight Event handler when highlighted element changes.	[payload: { ref: HTMLElement; value: string; }]

Slots

Slot	Scope
default The content of the component.	-

AutocompleteAnchor

Props

Prop	Type	Default
reference The reference (or anchor) element that is being referred to for positioning. If not provided will use the current component as anchor.	ReferenceElement	-
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"

Slots

Slot	Scope
default The content of the component.	-

AutocompleteEmpty

Props

Prop	Type	Default
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"

Slots

Slot	Scope
default The content of the component.	-

AutocompleteInput

Props

Prop	Type	Default
modelValue The controlled value of the filter. Can be binded with v-model.	string	-
autoFocus Focus on element when mounted.	boolean	-
disabled When true, prevents the user from interacting with item	boolean	-
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"

Events

Event	Payload
update:modelValue	[string]

Slots

Slot	Scope
default The content of the component.	-

AutocompleteItem

Props

Prop	Type	Default
textValue A string representation of the item contents. If the children are not plain text, then the textValue prop must also be set to a plain text representation, which will be used for autocomplete in the ComboBox.	string	-
valuerequired The value given as data when submitted with a name.	AcceptableValue	-
disabled When true, prevents the user from interacting with the item.	boolean	-
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"

Events

Event	Payload
select Event handler called when the selecting item. <br> It can be prevented by calling event.preventDefault.	[event: SelectEvent$3<AcceptableValue>]

Slots

Slot	Scope
default The content of the component.	-

AutocompleteList

Props

Prop	Type	Default
forceMount Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.	boolean	-
position The positioning mode to use, <br> inline is the default and you can control the position using CSS. <br> popper positions content in the same way as our other primitives, for example Popover or DropdownMenu.	"popper" | "inline"	"popper"
bodyLock The document.body will be lock, and scrolling will be disabled.	boolean	-
hideWhenEmpty When true, hides the content when there are no items matching the filter.	boolean	false
memoDependencies Reactive dependencies that should invalidate the memoized content subtree.	unknown[]	-
side The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.	"top" | "right" | "bottom" | "left"	"bottom"
sideOffset The distance in pixels from the trigger.	number	4
sideFlip Flip to the opposite side when colliding with boundary.	boolean	true
align The preferred alignment against the trigger. May change when collisions occur.	"center" | "start" | "end"	"center"
alignOffset An offset in pixels from the start or end alignment options.	number	0
alignFlip Flip alignment when colliding with boundary. May only occur when prioritizePosition is true.	boolean	true
avoidCollisions When true, overrides the side and align preferences to prevent collisions with boundary edges.	boolean	true
collisionBoundary The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.	Element | (Element | null)[] | null	[]
collisionPadding The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.	number | Partial<Record<"top" | "right" | "bottom" | "left", number>>	8
arrowPadding The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.	number	0
hideShiftedArrow When true, hides the arrow when it cannot be centered to the reference element.	boolean	true
sticky The sticky behavior on the align axis. partial will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.	"partial" | "always"	"partial"
hideWhenDetached Whether to hide the content when the trigger becomes fully occluded.	boolean	false
positionStrategy The type of CSS position property to use.	"absolute" | "fixed"	-
updatePositionStrategy Strategy to update the position of the floating element on every animation frame.	"always" | "optimized"	'optimized'
disableUpdateOnLayoutShift Whether to disable the update position for the content when the layout shifted.	boolean	false
prioritizePosition Force content to be position within the viewport. Might overlap the reference element, which may not be desired.	boolean	false
reference The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.	ReferenceElement	-
dir The reading direction of the popper content when applicable. <br> If omitted, inherits globally from ConfigProvider or assumes LTR (left-to-right) reading mode.	Direction	-
asChild Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.	boolean	-
as The element or component this component should render as. Can be overwritten by asChild.	AsTag | Component	"div"
disableOutsidePointerEvents When true, hover/focus/click interactions will be disabled on elements outside the DismissableLayer. Users will need to click twice on outside elements to interact with them: once to close the DismissableLayer, and again to trigger the element.	boolean	-

Events

Event	Payload
escapeKeyDown Event handler called when the escape key is down. Can be prevented.	[event: KeyboardEvent]
pointerDownOutside Event handler called when a pointerdown event happens outside of the DismissableLayer. Can be prevented.	[event: PointerDownOutsideEvent]
focusOutside Event handler called when the focus moves outside of the DismissableLayer. Can be prevented.	[event: FocusOutsideEvent]
interactOutside Event handler called when an interaction happens outside the DismissableLayer. Specifically, when a pointerdown event happens outside or focus moves outside of it. Can be prevented.	[event: PointerDownOutsideEvent | FocusOutsideEvent]

Slots

Slot	Scope
default The content of the component.	-

Accessibility

The field is a combobox. The list is a listbox, and the highlighted option follows the arrow keys.

Key	Description
ArrowDown or ArrowUp	Moves the highlight through the matching options.
Enter	Sets the input to the highlighted option.
Esc	Closes the list.