ProseKit

Appearance

prosekit/lit/inline-popover ​

InlinePopover ​

Extends ​

Constructors ​

new InlinePopover() ​

new InlinePopover(): InlinePopover

Returns ​

InlinePopover

Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).constructor

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 ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).defaultOpen

dismissOnEscape ​

dismissOnEscape: boolean

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

Default ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).dismissOnEscape

editor ​

editor: null | Editor<any>

The ProseKit editor instance.

Default ​
ts
null
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).editor

flip ​

flip: boolean | Placement[]

Default ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).flip

hide ​

hide: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).hide

hoist ​

hoist: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).hoist

inline ​

inline: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).inline

offset ​

offset: null | OffsetOptions

Default ​
ts
12
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).offset

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 ​
ts
null
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).onOpenChange

open ​

open: boolean

Whether the popover is open.

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

Default ​
ts
false
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).open

overlap ​

overlap: boolean

Default ​
ts
true
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).overlap

placement ​

placement: Placement

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

Default ​
ts
"top"
Inherited from ​

ElementBuilder<InlinePopoverProps>(useInlinePopover, defaultInlinePopoverProps).placement