columnContextMenuItem

columnContextMenuItem<TData, TArgs>(id, factory): ColumnContextMenuItemFactory<TData, TArgs>

Defined in: contextMenu.tsx:172

Helper function to create a column context menu item with full context access.

The factory function receives context including the clicked column header, table instance, and plugin configuration args.

Type Parameters

TData

TData

TArgs

TArgs = unknown

Parameters

id

string

Unique identifier for the menu item

factory

(ctx) => ContextMenuItemEntry

Factory function that receives context and returns menu item entry

Returns

ColumnContextMenuItemFactory<TData, TArgs>

Examples

columnContextMenuItem("hide-column", (ctx) => ({
  label: "Hide column",
  onClick: () => {
    ctx.column.toggleVisibility(false);
  },
}))

columnContextMenuItem("sort-asc", (ctx) => ({
  label: "Sort ascending",
  onClick: () => {
    ctx.column.toggleSorting(false);
  },
  visible: ctx.column.getCanSort(),
}))