ProseKit

Appearance

prosekit/lit/autocomplete ​

AutocompleteEmpty ​

Extends ​

Constructors ​

new AutocompleteEmpty() ​

new AutocompleteEmpty(): AutocompleteEmpty

Returns ​

AutocompleteEmpty

Inherited from ​

ElementBuilder<AutocompleteEmptyProps>(useAutocompleteEmpty, defaultAutocompleteEmptyProps).constructor

AutocompleteItem ​

Extends ​

Constructors ​

new AutocompleteItem() ​

new AutocompleteItem(): AutocompleteItem

Returns ​

AutocompleteItem

Inherited from ​

ElementBuilder<AutocompleteItemProps>(useAutocompleteItem, defaultAutocompleteItemProps).constructor

Properties ​

onSelect ​

onSelect: null | VoidFunction

The function to call when the item is selected.

Default ​
ts
null
Inherited from ​

ElementBuilder<AutocompleteItemProps>(useAutocompleteItem, defaultAutocompleteItemProps).onSelect

value ​

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 ​
ts
""
Inherited from ​

ElementBuilder<AutocompleteItemProps>(useAutocompleteItem, defaultAutocompleteItemProps).value

AutocompleteList ​

Extends ​

Constructors ​

new AutocompleteList() ​

new AutocompleteList(): AutocompleteList

Returns ​

AutocompleteList

Inherited from ​

ElementBuilder<AutocompleteListProps>(useAutocompleteList, defaultAutocompleteListProps).constructor

Properties ​

editor ​

editor: null | Editor<any>

Inherited from ​

ElementBuilder<AutocompleteListProps>(useAutocompleteList, defaultAutocompleteListProps).editor

AutocompletePopover ​

Extends ​

Constructors ​

new AutocompletePopover() ​

new AutocompletePopover(): AutocompletePopover

Returns ​

AutocompletePopover

Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).constructor

Properties ​

boundary ​

boundary: Boundary

Default ​
ts
"The body element"
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).boundary

editor ​

editor: null | Editor<any>

The ProseKit editor instance.

Default ​
ts
null
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).editor

fitViewport ​

fitViewport: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).fitViewport

hoist ​

hoist: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).hoist

inline ​

inline: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).inline

offset ​

offset: null | OffsetOptions

The distance between the popover and the hovered block.

Default ​
ts
4
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).offset

onOpenChange ​

onOpenChange: null | (open) => void

A callback that is called when the open state changes.

Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).onOpenChange

onQueryChange ​

onQueryChange: null | (query) => void

A callback that is called when the query changes.

Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).onQueryChange

overflowPadding ​

overflowPadding: number

Default ​
ts
8
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).overflowPadding

placement ​

placement: Placement

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

Default ​
ts
"bottom-start"
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).placement

regex ​

regex: null | RegExp

The regular expression to match the query text to autocomplete.

Default ​
ts
null
Inherited from ​

ElementBuilder<AutocompletePopoverProps>(useAutocompletePopover, defaultAutocompletePopoverProps).regex