Skip to content

prosekit/solid/table-handle

import {
  TableHandleColumnMenuRoot,
  TableHandleColumnMenuTrigger,
  TableHandleColumnPopup,
  TableHandleColumnPositioner,
  TableHandleDragPreview,
  TableHandleDropIndicator,
  TableHandleRoot,
  TableHandleRowMenuRoot,
  TableHandleRowMenuTrigger,
  TableHandleRowPopup,
  TableHandleRowPositioner,
} from 'prosekit/solid/table-handle'
import {
  MenuItem,
  MenuPopup,
  MenuPositioner,
} from 'prosekit/solid/menu'

<TableHandleRoot>
  <TableHandleDragPreview />
  <TableHandleDropIndicator />
  <TableHandleColumnPositioner>
    <TableHandleColumnPopup>
      <TableHandleColumnMenuRoot>
        <TableHandleColumnMenuTrigger>...</TableHandleColumnMenuTrigger>
        <MenuPositioner>
          <MenuPopup>
            <MenuItem>...</MenuItem>
          </MenuPopup>
        </MenuPositioner>
      </TableHandleColumnMenuRoot>
    </TableHandleColumnPopup>
  </TableHandleColumnPositioner>
  <TableHandleRowPositioner>
    <TableHandleRowPopup>
      <TableHandleRowMenuRoot>
        <TableHandleRowMenuTrigger>...</TableHandleRowMenuTrigger>
        <MenuPositioner>
          <MenuPopup>
            <MenuItem>...</MenuItem>
          </MenuPopup>
        </MenuPositioner>
      </TableHandleRowMenuRoot>
    </TableHandleRowPopup>
  </TableHandleRowPositioner>
</TableHandleRoot>

Props for the TableHandleColumnMenuRoot Solid component.

defaultOpen?: boolean

Whether the overlay is initially open.

false

open?: boolean | null

Whether the overlay is currently open.

null

disabled?: boolean

Whether the component should ignore user interaction.

false


Props for the TableHandleColumnMenuTrigger Solid component.


Props for the TableHandleColumnPopup Solid component.


Props for the TableHandleColumnPositioner Solid component.

placement?: Placement

The placement of the popover, relative to the hovered table cell.

"top"

strategy?: "fixed" | "absolute"

The strategy to use for positioning

"absolute"

autoUpdate?: boolean | AutoUpdateOptions

Options to activate auto-update listeners

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

true

hoist?: boolean

Whether to use the browser Popover API to place the floating element on top of other page content.

false

overlap?: boolean

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

false

fitViewport?: boolean

Whether to constrain the floating element's width and height to not exceed the viewport.

false

sameWidth?: boolean

Whether to constrain the floating element's width so that it matches the reference element.

false

sameHeight?: boolean

Whether to constrain the floating element's height so that it matches the reference element.

false

inline?: boolean

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

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.

'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.

'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.

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.

'floating'

altBoundary?: boolean

Whether to check the alternate elementContext's boundary. Please see https://floating-ui.com/docs/detectoverflow#altboundary for more information.

false


Props for the TableHandleDragPreview Solid component.


Props for the TableHandleDropIndicator Solid component.


Props for the TableHandleRoot Solid component.


Props for the TableHandleRowMenuRoot Solid component.

defaultOpen?: boolean

Whether the overlay is initially open.

false

open?: boolean | null

Whether the overlay is currently open.

null

disabled?: boolean

Whether the component should ignore user interaction.

false


Props for the TableHandleRowMenuTrigger Solid component.


Props for the TableHandleRowPopup Solid component.


Props for the TableHandleRowPositioner Solid component.

placement?: Placement

The placement of the popover, relative to the hovered table cell.

"left"

strategy?: "fixed" | "absolute"

The strategy to use for positioning

"absolute"

autoUpdate?: boolean | AutoUpdateOptions

Options to activate auto-update listeners

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

true

hoist?: boolean

Whether to use the browser Popover API to place the floating element on top of other page content.

false

overlap?: boolean

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

false

fitViewport?: boolean

Whether to constrain the floating element's width and height to not exceed the viewport.

false

sameWidth?: boolean

Whether to constrain the floating element's width so that it matches the reference element.

false

sameHeight?: boolean

Whether to constrain the floating element's height so that it matches the reference element.

false

inline?: boolean

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

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.

'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.

'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.

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.

'floating'

altBoundary?: boolean

Whether to check the alternate elementContext's boundary. Please see https://floating-ui.com/docs/detectoverflow#altboundary for more information.

false

const TableHandleColumnMenuRoot: Component<TableHandleColumnMenuRootProps & JSX.HTMLAttributes<TableHandleColumnMenuRootElement>>

A Solid component that renders an prosekit-table-handle-column-menu-root custom element.


const TableHandleColumnMenuTrigger: Component<TableHandleColumnMenuTriggerProps & JSX.HTMLAttributes<TableHandleColumnMenuTriggerElement>>

A Solid component that renders an prosekit-table-handle-column-menu-trigger custom element.


const TableHandleColumnPopup: Component<TableHandleColumnPopupProps & JSX.HTMLAttributes<TableHandleColumnPopupElement>>

A Solid component that renders an prosekit-table-handle-column-popup custom element.


const TableHandleColumnPositioner: Component<TableHandleColumnPositionerProps & JSX.HTMLAttributes<TableHandleColumnPositionerElement>>

A Solid component that renders an prosekit-table-handle-column-positioner custom element.


const TableHandleDragPreview: Component<TableHandleDragPreviewProps & JSX.HTMLAttributes<TableHandleDragPreviewElement>>

A Solid component that renders an prosekit-table-handle-drag-preview custom element.


const TableHandleDropIndicator: Component<TableHandleDropIndicatorProps & JSX.HTMLAttributes<TableHandleDropIndicatorElement>>

A Solid component that renders an prosekit-table-handle-drop-indicator custom element.


const TableHandleRoot: Component<TableHandleRootProps & JSX.HTMLAttributes<TableHandleRootElement>>

A Solid component that renders an prosekit-table-handle-root custom element.


const TableHandleRowMenuRoot: Component<TableHandleRowMenuRootProps & JSX.HTMLAttributes<TableHandleRowMenuRootElement>>

A Solid component that renders an prosekit-table-handle-row-menu-root custom element.


const TableHandleRowMenuTrigger: Component<TableHandleRowMenuTriggerProps & JSX.HTMLAttributes<TableHandleRowMenuTriggerElement>>

A Solid component that renders an prosekit-table-handle-row-menu-trigger custom element.


const TableHandleRowPopup: Component<TableHandleRowPopupProps & JSX.HTMLAttributes<TableHandleRowPopupElement>>

A Solid component that renders an prosekit-table-handle-row-popup custom element.


const TableHandleRowPositioner: Component<TableHandleRowPositionerProps & JSX.HTMLAttributes<TableHandleRowPositionerElement>>

A Solid component that renders an prosekit-table-handle-row-positioner custom element.