prosekit/svelte/inline-popover

import {
  InlinePopoverPopup,
  InlinePopoverPositioner,
  InlinePopoverRoot,
} from 'prosekit/svelte/inline-popover'

<InlinePopoverRoot>
  <InlinePopoverPositioner>
    <InlinePopoverPopup>...</InlinePopoverPopup>
  </InlinePopoverPositioner>
</InlinePopoverRoot>

Props for the InlinePopoverPopup Svelte component.

children?: Snippet<[]>

Props for the InlinePopoverPositioner Svelte component.

placement?: Placement

The initial placement of the floating element

Default

Section titled “Default”

"top"

offset?: OffsetOptions

The distance between the reference and floating element.

Default

Section titled “Default”

12

hide?: boolean

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

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”

false

overlap?: boolean

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

Default

Section titled “Default”

true

inline?: boolean

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

Default

Section titled “Default”

true

overflowPadding?: number

Describes the virtual padding around the boundary to check for overflow.

Default

Section titled “Default”

8

strategy?: "fixed" | "absolute"

The strategy to use for positioning

Default

Section titled “Default”

"absolute"

autoUpdate?: boolean | AutoUpdateOptions

Options to activate auto-update listeners

See

Section titled “See”

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

Default

Section titled “Default”

true

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

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

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'

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

children?: Snippet<[]>

Props for the InlinePopoverRoot Svelte component.

defaultOpen?: boolean

Whether the popover is open by default when some inline content is selected.

Default

Section titled “Default”

true

dismissOnEscape?: boolean

Whether the inline popover should be dismissed when the editor receives an Escape key press.

Default

Section titled “Default”

true

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

onOpenChange?: (event: OpenChangeEvent) => void

Emitted when the open state of the popover changes.

children?: Snippet<[]>

const InlinePopoverPopup: Component<InlinePopoverPopupProps & HTMLAttributes<InlinePopoverPopupElement>>

A Svelte component that renders an prosekit-inline-popover-popup custom element.

const InlinePopoverPositioner: Component<InlinePopoverPositionerProps & HTMLAttributes<InlinePopoverPositionerElement>>

A Svelte component that renders an prosekit-inline-popover-positioner custom element.

const InlinePopoverRoot: Component<InlinePopoverRootProps & HTMLAttributes<InlinePopoverRootElement>>

A Svelte component that renders an prosekit-inline-popover-root custom element.