prosekit/web/autocomplete
Classes
Section titled “Classes”AutocompleteEmptyElement
Section titled “AutocompleteEmptyElement”Extends
Section titled “Extends”AutocompleteEmptyElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
Inherited from
Section titled “Inherited from”AutocompleteEmptyElementBase.constructor
AutocompleteItemElement
Section titled “AutocompleteItemElement”Extends
Section titled “Extends”AutocompleteItemElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
Inherited from
Section titled “Inherited from”AutocompleteItemElementBase.constructor
Properties
Section titled “Properties”-
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
Section titled “Default”""
AutocompleteListElement
Section titled “AutocompleteListElement”Extends
Section titled “Extends”AutocompleteListElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
Inherited from
Section titled “Inherited from”AutocompleteListElementBase.constructor
Properties
Section titled “Properties”-
filter:null|ItemFilter -
The filter function to determine if an item should be shown in the listbox. By default, a simple case-insensitive substring match is used. You can provide a custom filter function to match against a more complex pattern. You can also pass
nullto disable filtering and allow all items to be shown.Default
Section titled “Default”defaultItemFilter
AutocompletePopoverElement
Section titled “AutocompletePopoverElement”Extends
Section titled “Extends”AutocompletePopoverElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
new AutocompletePopoverElement():AutocompletePopoverElement -
Inherited from
Section titled “Inherited from”AutocompletePopoverElementBase.constructor
Properties
Section titled “Properties”-
altBoundary:boolean -
Whether to check the alternate elementContext’s boundary. Please see https://floating-ui.com/docs/detectoverflow#altboundary for more information.
Default
Section titled “Default”false
-
autoUpdate:boolean|AutoUpdateOptions -
Options to activate auto-update listeners
https://floating-ui.com/docs/autoUpdate
Default
Section titled “Default”true
-
boundary:Boundary -
Default
Section titled “Default”"The body element"
-
elementContext:ElementContext -
The element that will be used to check for overflow. Please see https://floating-ui.com/docs/detectoverflow#elementcontext for more information.
Default
Section titled “Default”'floating'
-
fitViewport:boolean -
Default
Section titled “Default”true
-
flip:boolean|Placement[] -
Whether to flip the
placementin order to keep it in view when the preferred placement(s) will overflow the clipping boundary. You can also provide an array of placements to try sequentially if the preferredplacementdoes not fit.Default
Section titled “Default”true
-
hide:boolean -
Whether to hide the floating element when the reference element or the floating element is fully clipped.
Default
Section titled “Default”false
-
hoist:boolean -
Default
Section titled “Default”true
-
inline:boolean -
Default
Section titled “Default”true
-
offset:undefined|OffsetOptions -
The distance between the popover and the hovered block.
Default
Section titled “Default”4
-
overflowPadding:number -
Default
Section titled “Default”8
-
overlap:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement:Placement -
The placement of the popover, relative to the text cursor.
Default
Section titled “Default”"bottom-start"
-
The regular expression to match the query text to autocomplete.
Default
Section titled “Default”null
-
rootBoundary:RootBoundary -
Describes the root boundary that the element will be checked for overflow relative to. Please see https://floating-ui.com/docs/detectoverflow#rootboundary for more information.
Default
Section titled “Default”'viewport'
-
sameHeight:boolean -
Whether to constrain the floating element’s height so that it matches the reference element.
Default
Section titled “Default”false
-
sameWidth:boolean -
Whether to constrain the floating element’s width so that it matches the reference element.
Default
Section titled “Default”false
-
shift:boolean -
Whether the floating element should shift to keep it in view.
Default
Section titled “Default”true
-
strategy:"fixed"|"absolute" -
The strategy to use for positioning
Default
Section titled “Default”"absolute"
-
transform:boolean -
Whether to use CSS transforms to position the floating element instead of layout (
topandleftCSS properties). CSS transforms are more performant, but can cause conflicts with transform animations.Default
Section titled “Default”false
Interfaces
Section titled “Interfaces”AutocompleteItemEvents
Section titled “AutocompleteItemEvents”Extends
Section titled “Extends”ListboxItemEvents
Properties
Section titled “Properties”-
select:CustomEvent<void> -
Fired when the item is selected.
AutocompleteItemProps
Section titled “AutocompleteItemProps”Properties
Section titled “Properties”-
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
Section titled “Default”""
AutocompleteListEvents
Section titled “AutocompleteListEvents”Extends
Section titled “Extends”ListboxEvents
Properties
Section titled “Properties”-
valueChange:CustomEvent<string>
AutocompleteListProps
Section titled “AutocompleteListProps”Extends
Section titled “Extends”Pick<ListboxProps,"filter">
Properties
Section titled “Properties”-
filter:null|ItemFilter -
The filter function to determine if an item should be shown in the listbox. By default, a simple case-insensitive substring match is used. You can provide a custom filter function to match against a more complex pattern. You can also pass
nullto disable filtering and allow all items to be shown.Default
Section titled “Default”defaultItemFilter
AutocompletePopoverEvents
Section titled “AutocompletePopoverEvents”Extends
Section titled “Extends”OverlayPositionerEvents
Properties
Section titled “Properties”-
openChange:CustomEvent<boolean> -
Fired when the open state changes.
-
queryChange:CustomEvent<string> -
Fired when the query changes.
AutocompletePopoverProps
Section titled “AutocompletePopoverProps”Extends
Section titled “Extends”OverlayPositionerProps
Properties
Section titled “Properties”-
altBoundary:boolean -
Whether to check the alternate elementContext’s boundary. Please see https://floating-ui.com/docs/detectoverflow#altboundary for more information.
Default
Section titled “Default”false
-
autoUpdate:boolean|AutoUpdateOptions -
Options to activate auto-update listeners
https://floating-ui.com/docs/autoUpdate
Default
Section titled “Default”true
-
boundary:Boundary -
Default
Section titled “Default”"The body element"
-
elementContext:ElementContext -
The element that will be used to check for overflow. Please see https://floating-ui.com/docs/detectoverflow#elementcontext for more information.
Default
Section titled “Default”'floating'
-
fitViewport:boolean -
Default
Section titled “Default”true
-
flip:boolean|Placement[] -
Whether to flip the
placementin order to keep it in view when the preferred placement(s) will overflow the clipping boundary. You can also provide an array of placements to try sequentially if the preferredplacementdoes not fit.Default
Section titled “Default”true
-
hide:boolean -
Whether to hide the floating element when the reference element or the floating element is fully clipped.
Default
Section titled “Default”false
-
hoist:boolean -
Default
Section titled “Default”true
-
inline:boolean -
Default
Section titled “Default”true
-
offset:undefined|OffsetOptions -
The distance between the popover and the hovered block.
Default
Section titled “Default”4
-
overflowPadding:number -
Default
Section titled “Default”8
-
overlap:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement:Placement -
The placement of the popover, relative to the text cursor.
Default
Section titled “Default”"bottom-start"
-
The regular expression to match the query text to autocomplete.
Default
Section titled “Default”null
-
rootBoundary:RootBoundary -
Describes the root boundary that the element will be checked for overflow relative to. Please see https://floating-ui.com/docs/detectoverflow#rootboundary for more information.
Default
Section titled “Default”'viewport'
-
sameHeight:boolean -
Whether to constrain the floating element’s height so that it matches the reference element.
Default
Section titled “Default”false
-
sameWidth:boolean -
Whether to constrain the floating element’s width so that it matches the reference element.
Default
Section titled “Default”false
-
shift:boolean -
Whether the floating element should shift to keep it in view.
Default
Section titled “Default”true
-
strategy:"fixed"|"absolute" -
The strategy to use for positioning
Default
Section titled “Default”"absolute"
-
transform:boolean -
Whether to use CSS transforms to position the floating element instead of layout (
topandleftCSS properties). CSS transforms are more performant, but can cause conflicts with transform animations.Default
Section titled “Default”false
Variables
Section titled “Variables”autocompleteListEvents
Section titled “autocompleteListEvents”-
const autocompleteListEvents:EventDeclarations<AutocompleteListEvents>
autocompleteListProps
Section titled “autocompleteListProps”-
const autocompleteListProps:PropDeclarations<AutocompleteListProps>