prosekit/web/tooltip

<prosekit-tooltip-root>
  <prosekit-tooltip-trigger>...</prosekit-tooltip-trigger>
  <prosekit-tooltip-positioner>
    <prosekit-tooltip-popup>...</prosekit-tooltip-popup>
  </prosekit-tooltip-positioner>
</prosekit-tooltip-root>

<prosekit-tooltip-popup> custom element.

Properties: TooltipPopupProps

Data attributes:

new TooltipPopupElement(): TooltipPopupElement

addController(controller: ReactiveController): void

removeController(controller: ReactiveController): void

connectedCallback(): void

disconnectedCallback(): void

<prosekit-tooltip-positioner> custom element.

Properties: TooltipPositionerProps

Data attributes:

CSS variables:

new TooltipPositionerElement(): TooltipPositionerElement

strategy: "fixed" | "absolute"

The strategy to use for positioning

Default

Section titled “Default”

"absolute"

placement: Placement

The initial placement of the floating element

Default

Section titled “Default”

"top"

autoUpdate: boolean | AutoUpdateOptions

Options to activate auto-update listeners

See

Section titled “See”

https://floating-ui.com/docs/autoUpdate

Default

Section titled “Default”

true

hoist: boolean

Whether to use the browser Popover API to place the floating element on top of other page content.

Default

Section titled “Default”

true

offset: OffsetOptions

The distance between the reference and floating element.

Default

Section titled “Default”

6

flip: boolean | Placement[]

Whether to flip the placement in 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 preferred placement does not fit.

Default

Section titled “Default”

true

shift: boolean

Whether the floating element should shift to keep it in view.

Default

Section titled “Default”

true

overlap: boolean

Whether the floating element can overlap the reference element to keep it in view.

Default

Section titled “Default”

false

fitViewport: boolean

Whether to constrain the floating element's width and height to not exceed the viewport.

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

sameHeight: boolean

Whether to constrain the floating element's height so that it matches the reference element.

Default

Section titled “Default”

false

inline: boolean

Whether to improve positioning for inline reference elements that span over multiple lines.

Default

Section titled “Default”

false

hide: boolean

Whether to hide the floating element when the reference element or the floating element is fully clipped.

Default

Section titled “Default”

false

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'

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'

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

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'

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

addController(controller: ReactiveController): void

removeController(controller: ReactiveController): void

connectedCallback(): void

disconnectedCallback(): void

<prosekit-tooltip-root> custom element.

Properties: TooltipRootProps

Events: TooltipRootEvents

new TooltipRootElement(): TooltipRootElement

defaultOpen: boolean

Whether the overlay is initially open.

Default

Section titled “Default”

false

open: boolean | null

Whether the overlay is currently open.

Default

Section titled “Default”

null

disabled: boolean

Whether the component should ignore user interaction.

Default

Section titled “Default”

false

addController(controller: ReactiveController): void

removeController(controller: ReactiveController): void

connectedCallback(): void

disconnectedCallback(): void

<prosekit-tooltip-trigger> custom element.

Properties: TooltipTriggerProps

new TooltipTriggerElement(): TooltipTriggerElement

disabled: boolean

Whether the component should ignore user interaction.

Default

Section titled “Default”

false

openDelay: number

The delay in milliseconds before opening the tooltip on hover.

Default

Section titled “Default”

600

closeDelay: number

The delay in milliseconds before closing the tooltip when hover/focus ends.

Default

Section titled “Default”

0

addController(controller: ReactiveController): void

removeController(controller: ReactiveController): void

connectedCallback(): void

disconnectedCallback(): void

strategy: "fixed" | "absolute"

The strategy to use for positioning

Default

Section titled “Default”

"absolute"

placement: Placement

The initial placement of the floating element

Default

Section titled “Default”

"top"

autoUpdate: boolean | AutoUpdateOptions

Options to activate auto-update listeners

See

Section titled “See”

https://floating-ui.com/docs/autoUpdate

Default

Section titled “Default”

true

hoist: boolean

Whether to use the browser Popover API to place the floating element on top of other page content.

Default

Section titled “Default”

true

offset: OffsetOptions

The distance between the reference and floating element.

Default

Section titled “Default”

6

flip: boolean | Placement[]

Whether to flip the placement in 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 preferred placement does not fit.

Default

Section titled “Default”

true

shift: boolean

Whether the floating element should shift to keep it in view.

Default

Section titled “Default”

true

overlap: boolean

Whether the floating element can overlap the reference element to keep it in view.

Default

Section titled “Default”

false

fitViewport: boolean

Whether to constrain the floating element's width and height to not exceed the viewport.

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

sameHeight: boolean

Whether to constrain the floating element's height so that it matches the reference element.

Default

Section titled “Default”

false

inline: boolean

Whether to improve positioning for inline reference elements that span over multiple lines.

Default

Section titled “Default”

false

hide: boolean

Whether to hide the floating element when the reference element or the floating element is fully clipped.

Default

Section titled “Default”

false

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'

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'

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

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'

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

defaultOpen: boolean

Whether the overlay is initially open.

Default

Section titled “Default”

false

open: boolean | null

Whether the overlay is currently open.

Default

Section titled “Default”

null

disabled: boolean

Whether the component should ignore user interaction.

Default

Section titled “Default”

false

disabled: boolean

Whether the component should ignore user interaction.

Default

Section titled “Default”

false

openDelay: number

The delay in milliseconds before opening the tooltip on hover.

Default

Section titled “Default”

600

closeDelay: number

The delay in milliseconds before closing the tooltip when hover/focus ends.

Default

Section titled “Default”

0

openChange: OpenChangeEvent

Emitted when the tooltip is opened or closed.

function registerTooltipRootElement(): void

function registerTooltipTriggerElement(): void

function registerTooltipPopupElement(): void

function registerTooltipPositionerElement(): void

Re-exports OpenChangeEvent