Skip to content

prosekit/vue/autocomplete

AutocompleteEmptyEmits

Emits for the AutocompleteEmpty component.

AutocompleteEmptyProps

Props for the AutocompleteEmpty component.

AutocompleteItemEmits

Emits for the AutocompleteItem component.

AutocompleteItemProps

Props for the AutocompleteItem component.

value?: string

The value of the item, which will be matched against the query.

If not provided, the value is the item's text content.

Default: ""

AutocompleteListEmits

Emits for the AutocompleteList component.

AutocompleteListProps

Props for the AutocompleteList component.

AutocompletePopoverEmits

Emits for the AutocompletePopover component.

openChange: (event: boolean) => void

Fired when the open state changes.

queryChange: (event: string) => void

Fired when the query changes.

AutocompletePopoverProps

Props for the AutocompletePopover component.

boundary?: Boundary

Default: "The body element"

fitViewport?: boolean

Default: true

hoist?: boolean

Default: true

inline?: boolean

Default: true

offset?: OffsetOptions

The distance between the popover and the hovered block.

Default: 4

overflowPadding?: number

Default: 8

placement?: Placement

The placement of the popover, relative to the text cursor.

Default: "bottom-start"

regex?: null | RegExp

The regular expression to match the query text to autocomplete.

Default: null

AutocompleteEmpty

Type: DefineSetupFnComponent<AutocompleteEmptyProps & HTMLAttributes, AutocompleteEmptyEmits>

AutocompleteItem

Type: DefineSetupFnComponent<AutocompleteItemProps & HTMLAttributes, AutocompleteItemEmits>

AutocompleteList

Type: DefineSetupFnComponent<AutocompleteListProps & HTMLAttributes, AutocompleteListEmits>

AutocompletePopover

Type: DefineSetupFnComponent<AutocompletePopoverProps & HTMLAttributes, AutocompletePopoverEmits>