prosekit/web/popover
Classes
Section titled “Classes”PopoverContentElement
Section titled “PopoverContentElement”Extends
Section titled “Extends”PopoverContentElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
Inherited from
Section titled “Inherited from”PopoverContentElementBase.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 -
Describes the clipping element(s) or area that overflow will be checked relative to. Please see https://floating-ui.com/docs/detectoverflow#boundary for more information.
Default
Section titled “Default”'clippingAncestors'
-
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 -
Whether to constrain the floating element’s width and height to not exceed the viewport.
Default
Section titled “Default”false
-
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 -
Whether to use the browser Popover API to place the floating element on top of other page content. When enabled, the floating element won’t be clipped by an ancestor. This provides a similar result to React’s
<Portals>or Vue’s<Teleport>.Default
Section titled “Default”true
-
inline:boolean -
Whether to improve positioning for inline reference elements that span over multiple lines.
Default
Section titled “Default”false
-
offset?:OffsetOptions -
The distance between the reference and floating element.
Default
Section titled “Default”6
-
overflowPadding:number -
Describes the virtual padding around the boundary to check for overflow. Please see https://floating-ui.com/docs/detectoverflow#padding for more information.
Default
Section titled “Default”4
-
overlap:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement:Placement -
The initial placement of the floating element
Default
Section titled “Default”"top"
-
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
PopoverRootElement
Section titled “PopoverRootElement”Extends
Section titled “Extends”PopoverRootElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
Inherited from
Section titled “Inherited from”PopoverRootElementBase.constructor
Properties
Section titled “Properties”-
defaultOpen:boolean -
Whether the popover is open by default.
Default
Section titled “Default”false
-
open:boolean -
Whether the popover is open.
Default
Section titled “Default”false
PopoverTriggerElement
Section titled “PopoverTriggerElement”Extends
Section titled “Extends”PopoverTriggerElementBase
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”-
Inherited from
Section titled “Inherited from”PopoverTriggerElementBase.constructor
Interfaces
Section titled “Interfaces”PopoverContentEvents
Section titled “PopoverContentEvents”Extends
Section titled “Extends”PopoverContentEvents
Properties
Section titled “Properties”-
escapeKeyDown:EscapeKeyDownEvent -
Fired when the escape key is pressed.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
-
focusOutside:FocusOutsideEvent -
Fired when the focus is moved outside the element.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
-
interactOutside:InteractOutsideEvent -
Fired when an interaction (pointer or focus) happens outside the component.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
-
pointerDownOutside:PointerDownOutsideEvent -
Fired when the pointer is pressed down outside the element.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
PopoverContentProps
Section titled “PopoverContentProps”Extends
Section titled “Extends”PopoverContentProps
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 -
Describes the clipping element(s) or area that overflow will be checked relative to. Please see https://floating-ui.com/docs/detectoverflow#boundary for more information.
Default
Section titled “Default”'clippingAncestors'
-
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 -
Whether to constrain the floating element’s width and height to not exceed the viewport.
Default
Section titled “Default”false
-
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 -
Whether to use the browser Popover API to place the floating element on top of other page content. When enabled, the floating element won’t be clipped by an ancestor. This provides a similar result to React’s
<Portals>or Vue’s<Teleport>.Default
Section titled “Default”true
-
inline:boolean -
Whether to improve positioning for inline reference elements that span over multiple lines.
Default
Section titled “Default”false
-
offset?:OffsetOptions -
The distance between the reference and floating element.
Default
Section titled “Default”6
-
overflowPadding:number -
Describes the virtual padding around the boundary to check for overflow. Please see https://floating-ui.com/docs/detectoverflow#padding for more information.
Default
Section titled “Default”4
-
overlap:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement:Placement -
The initial placement of the floating element
Default
Section titled “Default”"top"
-
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
PopoverRootEvents
Section titled “PopoverRootEvents”Extends
Section titled “Extends”PopoverRootEvents
Properties
Section titled “Properties”-
openChange:CustomEvent<boolean>
PopoverRootProps
Section titled “PopoverRootProps”Extends
Section titled “Extends”PopoverRootProps
Properties
Section titled “Properties”-
defaultOpen:boolean -
Whether the popover is open by default.
Default
Section titled “Default”false
-
open:boolean -
Whether the popover is open.
Default
Section titled “Default”false
PopoverTriggerEvents
Section titled “PopoverTriggerEvents”Extends
Section titled “Extends”PopoverTriggerEvents
PopoverTriggerProps
Section titled “PopoverTriggerProps”Extends
Section titled “Extends”PopoverTriggerProps
PopoverContent
Section titled “PopoverContent”popoverRootEvents
Section titled “popoverRootEvents”-
const popoverRootEvents:EventDeclarations<PopoverRootEvents>