prosekit/vue/table-handle
Interfaces
Section titled “Interfaces”TableHandleColumnRootEmits
Section titled “TableHandleColumnRootEmits”Emits for the TableHandleColumnRoot component.
Extends
Section titled “Extends”CreateEmits<Events>
TableHandleColumnRootProps
Section titled “TableHandleColumnRootProps”Props for the TableHandleColumnRoot component.
Extends
Section titled “Extends”Properties
Section titled “Properties”-
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
-
autoUpdate?:boolean|AutoUpdateOptions -
Options to activate auto-update listeners
https://floating-ui.com/docs/autoUpdate
Default
Section titled “Default”true
-
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'
-
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'
-
fitViewport?:boolean -
Whether to constrain the floating element’s width and height to not exceed the viewport.
Default
Section titled “Default”false
-
flip?:boolean|Placement[] -
Whether to flip the
placementin 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 preferredplacementdoes not fit.Default
Section titled “Default”true
-
hide?:boolean -
Whether to hide the floating element when the reference element or the floating element is fully clipped.
Default
Section titled “Default”false
-
hoist?:boolean -
Whether to use the browser Popover API to place the floating element on top of other page content. When enabled, the floating element won’t be clipped by an ancestor. This provides a similar result to React’s
<Portals>or Vue’s<Teleport>.Default
Section titled “Default”true
-
inline?:boolean -
Whether to improve positioning for inline reference elements that span over multiple lines.
Default
Section titled “Default”false
-
offset?:OffsetOptions -
The distance between the reference and floating element.
Default
Section titled “Default”6
-
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
-
overlap?:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement?:Placement -
The placement of the popover, relative to the hovered table cell.
Default
Section titled “Default”"top"
-
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'
-
sameHeight?:boolean -
Whether to constrain the floating element’s height so that it matches the reference element.
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
-
shift?:boolean -
Whether the floating element should shift to keep it in view.
Default
Section titled “Default”true
-
strategy?:"fixed"|"absolute" -
The strategy to use for positioning
Default
Section titled “Default”"absolute"
-
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
TableHandleColumnTriggerEmits
Section titled “TableHandleColumnTriggerEmits”Emits for the TableHandleColumnTrigger component.
Extends
Section titled “Extends”CreateEmits<Events>
TableHandleColumnTriggerProps
Section titled “TableHandleColumnTriggerProps”Props for the TableHandleColumnTrigger component.
Extends
Section titled “Extends”Properties
Section titled “Properties”TableHandlePopoverContentEmits
Section titled “TableHandlePopoverContentEmits”Emits for the TableHandlePopoverContent component.
Extends
Section titled “Extends”CreateEmits<TableHandlePopoverContentEvents>
Properties
Section titled “Properties”-
escapeKeyDown: (event:EscapeKeyDownEvent) =>void -
Fired when the escape key is pressed.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
-
focusOutside: (event:FocusOutsideEvent) =>void -
Fired when the focus is moved outside the element.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
-
interactOutside: (event:InteractOutsideEvent) =>void -
Fired when an interaction (pointer or focus) happens outside the component.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
-
pointerDownOutside: (event:PointerDownOutsideEvent) =>void -
Fired when the pointer is pressed down outside the element.
By default, the popover will be closed. It can be prevented by calling
preventDefault().
TableHandlePopoverContentProps
Section titled “TableHandlePopoverContentProps”Props for the TableHandlePopoverContent component.
Extends
Section titled “Extends”Properties
Section titled “Properties”-
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
-
autoUpdate?:boolean|AutoUpdateOptions -
Options to activate auto-update listeners
https://floating-ui.com/docs/autoUpdate
Default
Section titled “Default”true
-
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'
-
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'
-
eventTarget?:HTMLElement|TypedEventTarget<"keydown"> -
By default, the menu element will listen for keydown events. You can pass a different element to listen for keydown events.
-
fitViewport?:boolean -
Whether to constrain the floating element’s width and height to not exceed the viewport.
Default
Section titled “Default”false
-
flip?:boolean|Placement[] -
Whether to flip the
placementin 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 preferredplacementdoes not fit.Default
Section titled “Default”true
-
hide?:boolean -
Whether to hide the floating element when the reference element or the floating element is fully clipped.
Default
Section titled “Default”false
-
hoist?:boolean -
Whether to use the browser Popover API to place the floating element on top of other page content. When enabled, the floating element won’t be clipped by an ancestor. This provides a similar result to React’s
<Portals>or Vue’s<Teleport>.Default
Section titled “Default”true
-
inline?:boolean -
Whether to improve positioning for inline reference elements that span over multiple lines.
Default
Section titled “Default”false
-
offset?:OffsetOptions -
Default
Section titled “Default”{mainAxis: -4, crossAxis: 4}
-
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
-
overlap?:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement?:Placement -
Default
Section titled “Default”'bottom-start'
-
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'
-
sameHeight?:boolean -
Whether to constrain the floating element’s height so that it matches the reference element.
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
-
shift?:boolean -
Whether the floating element should shift to keep it in view.
Default
Section titled “Default”true
-
strategy?:"fixed"|"absolute" -
The strategy to use for positioning
Default
Section titled “Default”"absolute"
-
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
TableHandlePopoverItemEmits
Section titled “TableHandlePopoverItemEmits”Emits for the TableHandlePopoverItem component.
Extends
Section titled “Extends”CreateEmits<TableHandlePopoverItemEvents>
Properties
Section titled “Properties”-
select: (event:CustomEvent<void>) =>void -
Fired when the item is selected.
TableHandlePopoverItemProps
Section titled “TableHandlePopoverItemProps”Props for the TableHandlePopoverItem component.
Extends
Section titled “Extends”Properties
Section titled “Properties”-
filter?:ItemFilter -
The filter function to determine if an item should be shown in the listbox.
Default
Section titled “Default”defaultItemFilter
-
query?:string -
The query string to filter the listbox items.
Default
Section titled “Default”""
-
value?:string -
The value of the item. Every item must have a unique value in the parent list. By default, a random value is generated.
Default
Section titled “Default”""
TableHandleRootEmits
Section titled “TableHandleRootEmits”Emits for the TableHandleRoot component.
Extends
Section titled “Extends”CreateEmits<Events>
TableHandleRootProps
Section titled “TableHandleRootProps”Props for the TableHandleRoot component.
Extends
Section titled “Extends”TableHandleRowRootEmits
Section titled “TableHandleRowRootEmits”Emits for the TableHandleRowRoot component.
Extends
Section titled “Extends”CreateEmits<Events>
TableHandleRowRootProps
Section titled “TableHandleRowRootProps”Props for the TableHandleRowRoot component.
Extends
Section titled “Extends”Properties
Section titled “Properties”-
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
-
autoUpdate?:boolean|AutoUpdateOptions -
Options to activate auto-update listeners
https://floating-ui.com/docs/autoUpdate
Default
Section titled “Default”true
-
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'
-
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'
-
fitViewport?:boolean -
Whether to constrain the floating element’s width and height to not exceed the viewport.
Default
Section titled “Default”false
-
flip?:boolean|Placement[] -
Whether to flip the
placementin 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 preferredplacementdoes not fit.Default
Section titled “Default”true
-
hide?:boolean -
Whether to hide the floating element when the reference element or the floating element is fully clipped.
Default
Section titled “Default”false
-
hoist?:boolean -
Whether to use the browser Popover API to place the floating element on top of other page content. When enabled, the floating element won’t be clipped by an ancestor. This provides a similar result to React’s
<Portals>or Vue’s<Teleport>.Default
Section titled “Default”true
-
inline?:boolean -
Whether to improve positioning for inline reference elements that span over multiple lines.
Default
Section titled “Default”false
-
offset?:OffsetOptions -
The distance between the reference and floating element.
Default
Section titled “Default”6
-
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
-
overlap?:boolean -
Whether the floating element can overlap the reference element to keep it in view.
Default
Section titled “Default”false
-
placement?:Placement -
The placement of the popover, relative to the hovered table cell.
Default
Section titled “Default”"left"
-
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'
-
sameHeight?:boolean -
Whether to constrain the floating element’s height so that it matches the reference element.
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
-
shift?:boolean -
Whether the floating element should shift to keep it in view.
Default
Section titled “Default”true
-
strategy?:"fixed"|"absolute" -
The strategy to use for positioning
Default
Section titled “Default”"absolute"
-
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
TableHandleRowTriggerEmits
Section titled “TableHandleRowTriggerEmits”Emits for the TableHandleRowTrigger component.
Extends
Section titled “Extends”CreateEmits<TableHandleRowTriggerEvents>
Properties
Section titled “Properties”-
select: (event:CustomEvent<void>) =>void
TableHandleRowTriggerProps
Section titled “TableHandleRowTriggerProps”Props for the TableHandleRowTrigger component.
Extends
Section titled “Extends”Properties
Section titled “Properties”Variables
Section titled “Variables”TableHandleColumnRoot
Section titled “TableHandleColumnRoot”-
const TableHandleColumnRoot:DefineSetupFnComponent<TableHandleColumnRootProps&HTMLAttributes,TableHandleColumnRootEmits>
TableHandleColumnTrigger
Section titled “TableHandleColumnTrigger”-
const TableHandleColumnTrigger:DefineSetupFnComponent<TableHandleColumnTriggerProps&HTMLAttributes,TableHandleColumnTriggerEmits>
TableHandlePopoverContent
Section titled “TableHandlePopoverContent”-
const TableHandlePopoverContent:DefineSetupFnComponent<TableHandlePopoverContentProps&HTMLAttributes,TableHandlePopoverContentEmits>
TableHandlePopoverItem
Section titled “TableHandlePopoverItem”-
const TableHandlePopoverItem:DefineSetupFnComponent<TableHandlePopoverItemProps&HTMLAttributes,TableHandlePopoverItemEmits>
TableHandleRoot
Section titled “TableHandleRoot”-
const TableHandleRoot:DefineSetupFnComponent<TableHandleRootProps&HTMLAttributes,TableHandleRootEmits>
TableHandleRowRoot
Section titled “TableHandleRowRoot”-
const TableHandleRowRoot:DefineSetupFnComponent<TableHandleRowRootProps&HTMLAttributes,TableHandleRowRootEmits>
TableHandleRowTrigger
Section titled “TableHandleRowTrigger”-
const TableHandleRowTrigger:DefineSetupFnComponent<TableHandleRowTriggerProps&HTMLAttributes,TableHandleRowTriggerEmits>