prosekit/web/inline-popover

InlinePopoverElement

Renames and re-exports InlinePopover

InlinePopoverProps

Extends

• Omit<OverlayPositionerProps, "placement" | "offset">

Properties

defaultOpen

defaultOpen: boolean

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

When defaultOpen is true, the popover will open or close based on the inline selection. When defaultOpen is false, the popover will never be opened unless the open prop is true.

Default

true

dismissOnEscape

dismissOnEscape: boolean

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

Default

true

editor

editor: null | Editor<any>

The ProseKit editor instance.

Default

null

flip

flip: boolean | Placement[]

Default

true

Overrides

Omit.flip

hide

hide: boolean

Default

true

Overrides

Omit.hide

hoist

hoist: boolean

Default

true

Overrides

Omit.hoist

inline

inline: boolean

Default

true

Overrides

Omit.inline

offset

offset: null | OffsetOptions

Default

12

onOpenChange

onOpenChange: null | (open) => void

Event handler called when the open state changed caused by user interaction (i.e. select or unselect inline content).

Default

null

open

open: boolean

Whether the popover is open.

Notice that the popover will be always hidden if the inline selection is empty.

Default

false

overlap

overlap: boolean

Default

true

Overrides

Omit.overlap

placement

placement: Placement

The placement of the popover, relative to the selected inline content.

Default

"top"

---

defaultInlinePopoverProps

const defaultInlinePopoverProps: Readonly<object>

Type declaration

Name	Type	Default value
boundary	never[]	[]
defaultOpen	true	true
dismissOnEscape	true	true
editor	null	null
flip	true	true
hide	true	true
hoist	true	true
inline	true	true
offset	12	12
onOpenChange	null	null
open	false	false
overflowPadding	8	8
overlap	true	true
placement	"top"	'top'
shift	true	true