prosekit/vue/block-handle
Interfaces
Section titled “Interfaces”BlockHandleAddProps
Section titled “BlockHandleAddProps”Props for the BlockHandleAdd component.
BlockHandleAddEmits
Section titled “BlockHandleAddEmits”Emits for the BlockHandleAdd component.
BlockHandleDraggableProps
Section titled “BlockHandleDraggableProps”Props for the BlockHandleDraggable component.
BlockHandleDraggableEmits
Section titled “BlockHandleDraggableEmits”Emits for the BlockHandleDraggable component.
BlockHandlePopoverProps
Section titled “BlockHandlePopoverProps”Props for the BlockHandlePopover component.
Properties
Section titled “Properties”-
strategy?:"fixed"|"absolute" -
The strategy to use for positioning
Default
Section titled “Default”"absolute"
-
autoUpdate?:boolean|AutoUpdateOptions -
Options to activate auto-update listeners
https://floating-ui.com/docs/autoUpdate
Default
Section titled “Default”true
-
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
-
offset?:OffsetOptions -
The distance between the reference and floating element.
Default
Section titled “Default”6
-
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
-
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
-
placement?:Placement -
The placement of the popover, relative to the hovered block.
Default
Section titled “Default”"left"
-
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
BlockHandlePopoverEmits
Section titled “BlockHandlePopoverEmits”Emits for the BlockHandlePopover component.
Properties
Section titled “Properties”-
stateChange: (event: {node:ProseMirrorNode;pos:number; } |null) =>void -
Fired when the hovered block changes.
Variables
Section titled “Variables”BlockHandleAdd
Section titled “BlockHandleAdd”-
const BlockHandleAdd:DefineSetupFnComponent<BlockHandleAddProps&HTMLAttributes,BlockHandleAddEmits>
BlockHandleDraggable
Section titled “BlockHandleDraggable”-
const BlockHandleDraggable:DefineSetupFnComponent<BlockHandleDraggableProps&HTMLAttributes,BlockHandleDraggableEmits>
BlockHandlePopover
Section titled “BlockHandlePopover”-
const BlockHandlePopover:DefineSetupFnComponent<BlockHandlePopoverProps&HTMLAttributes,BlockHandlePopoverEmits>