Column Sizing

The column sizing feature provides methods and state for managing column widths and enabling column resizing. These properties are available on the table instance when using the column sizing feature. See the column sizing guide for usage examples and configuration details.

Prop	Type
getCenterTotalSize If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns.	() => number
getLeftTotalSize Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns.	() => number
getRightTotalSize Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns.	() => number
getTotalSize Returns the total size of the table by calculating the sum of the sizes of all leaf-columns.	() => number
resetColumnSizing Resets column sizing to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.	( defaultState?: boolean, ) => void
resetHeaderSizeInfo Resets column sizing info to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.	( defaultState?: boolean, ) => void
setColumnSizing Sets the column sizing state using an updater function or a value. This will trigger the underlying `onColumnSizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.	( updater: \| T \| ((old: T) => T), ) => void
setColumnSizingInfo Sets the column sizing info state using an updater function or a value. This will trigger the underlying `onColumnSizingInfoChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.	( updater: \| T \| ((old: T) => T), ) => void

getCenterTotalSize

Type

() => number

Description

If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns.

getLeftTotalSize

Type

() => number

Description

Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns.

getRightTotalSize

Type

() => number

Description

Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns.

getTotalSize

Type

() => number

Description

Returns the total size of the table by calculating the sum of the sizes of all leaf-columns.

resetColumnSizing

Type

(
  defaultState?: boolean,
) => void

Description

Resets column sizing to its initial state. If defaultState is true, the default state for the table will be used instead of the initialValue provided to the table.

resetHeaderSizeInfo

Type

(
  defaultState?: boolean,
) => void

Description

Resets column sizing info to its initial state. If defaultState is true, the default state for the table will be used instead of the initialValue provided to the table.

setColumnSizing

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Sets the column sizing state using an updater function or a value. This will trigger the underlying onColumnSizingChange function if one is passed to the table options, otherwise the state will be managed automatically by the table.

setColumnSizingInfo

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Sets the column sizing info state using an updater function or a value. This will trigger the underlying onColumnSizingInfoChange function if one is passed to the table options, otherwise the state will be managed automatically by the table.

Column Sizing

Expanded