Visibility

The visibility feature provides methods and state for controlling which columns are visible in the table. These properties are available on the table instance when using the column visibility feature. See the column visibility guide for usage examples and configuration details.

Prop	Type
getCenterVisibleLeafColumns If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table.	() => Column< TData, unknown, ColumnMeta >[]
getIsAllColumnsVisible Returns whether all columns are visible	() => boolean
getIsSomeColumnsVisible Returns whether any columns are visible	() => boolean
getLeftVisibleLeafColumns If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table.	() => Column< TData, unknown, ColumnMeta >[]
getRightVisibleLeafColumns If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table.	() => Column< TData, unknown, ColumnMeta >[]
getToggleAllColumnsVisibilityHandler Returns a handler for toggling the visibility of all columns, meant to be bound to a `input[type=checkbox]` element.	() => ( event: unknown, ) => void
getVisibleFlatColumns Returns a flat array of columns that are visible, including parent columns.	() => Column< TData, unknown, ColumnMeta >[]
getVisibleLeafColumns Returns a flat array of leaf-node columns that are visible.	() => Column< TData, unknown, ColumnMeta >[]
resetColumnVisibility Resets the column visibility state to the initial state. If `defaultState` is provided, the state will be reset to `{}`	( defaultState?: boolean, ) => void
setColumnVisibility Sets or updates the `state.columnVisibility` state.	( updater: Updater<VisibilityState>, ) => void
toggleAllColumnsVisible Toggles the visibility of all columns.	( value?: boolean, ) => void

getCenterVisibleLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table.

getIsAllColumnsVisible

Type

() => boolean

Description

Returns whether all columns are visible

getIsSomeColumnsVisible

Type

() => boolean

Description

Returns whether any columns are visible

getLeftVisibleLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table.

getRightVisibleLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table.

getToggleAllColumnsVisibilityHandler

Type

() => (
  event: unknown,
) => void

Description

Returns a handler for toggling the visibility of all columns, meant to be bound to a input[type=checkbox] element.

getVisibleFlatColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

Returns a flat array of columns that are visible, including parent columns.

getVisibleLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

Returns a flat array of leaf-node columns that are visible.

resetColumnVisibility

Type

(
  defaultState?: boolean,
) => void

Description

Resets the column visibility state to the initial state. If defaultState is provided, the state will be reset to {}

setColumnVisibility

Type

(
  updater: Updater<VisibilityState>,
) => void

Description

Sets or updates the state.columnVisibility state.

toggleAllColumnsVisible

Type

(
  value?: boolean,
) => void

Description

Toggles the visibility of all columns.

Sorting

Cell