FeatureOptions

Enable this setting to automatically reset the expanded state of the table when expanding state changes. API Docs Guide

If set to true, pagination will be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc. API Docs Guide

Enables or disables right-to-left support for resizing the column. defaults to 'ltr'. API Docs Guide

Determines when the columnSizing state is updated. onChange updates the state when the user is dragging the resize handle. onEnd updates the state when the user releases the resize handle. API Docs Guide

Enables/disables column filtering for all columns. API Docs Guide

Enables/disables column pinning for the table. Defaults to true. API Docs Guide

Enables or disables column resizing for the column. API Docs Guide

Enable/disable expanding for all rows. API Docs Guide

Enables/disables all filtering for the table. API Docs Guide

Enables/disables global filtering for all columns. API Docs Guide

Enables/disables grouping for the table. API Docs Guide

Whether to enable column hiding. Defaults to true. API Docs Guide

Enables/disables the ability to remove multi-sorts API Docs Guide

Enables/Disables multi-sorting for the table. API Docs Guide

Enables/disables row pinning for the table. Defaults to true. API Docs Guide

Enables/Disables sorting for the table. API Docs Guide

Enables/Disables the ability to remove sorting for the table.

Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row. (Use in combination with expanding or grouping features) API Docs Guide

By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to true will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included). API Docs Guide

If provided, this function will be called with the column and should return true or false to indicate whether this column should be used for global filtering.

This function is responsible for returning the expanded row model. If this function is not provided, the table will not expand rows. You can use the default exported getExpandedRowModel function to get the expanded row model or implement your own. API Docs Guide

If provided, this function is called once per table and should return a new function which will calculate and return the row model for the table when it's filtered.

Returns the row model after grouping has taken place, but no further. API Docs Guide

If provided, allows you to override the default behavior of determining whether a row is currently expanded. API Docs Guide

Returns the row model after pagination has taken place, but no further.

If provided, allows you to override the default behavior of determining whether a row can be expanded. API Docs Guide

This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported getSortedRowModel() from your adapter to your table or implement your own. API Docs Guide

The filter function to use for global filtering.

Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here. API Docs Guide

Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return true if the event should trigger a multi-sort. API Docs Guide

When false, pinned rows will not be visible if they are filtered or paginated out of the table. When true, pinned rows will always be visible regardless of filtering or pagination. Defaults to true. API Docs Guide

Enables manual row expansion. If this is set to true, getExpandedRowModel will not be used to expand rows and you would be expected to perform the expansion in your own data model. This is useful if you are doing server-side expansion. API Docs Guide

Disables the getFilteredRowModel from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering. API Docs Guide

Enables manual grouping. If this option is set to true, the table will not automatically group rows using getGroupedRowModel() and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation. API Docs Guide

Enables manual pagination. If this option is set to true, the table will not automatically paginate rows using getPaginationRowModel() and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation. API Docs Guide

Enables manual sorting for the table. If this is true, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting. API Docs Guide

By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to 0 will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to 1 will cause filtering to only be applied to child leaf rows 1 level deep, and so on. var : This is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter. var * API Docs: * API Docs var * Guide: * Guide

Set a maximum number of columns that can be multi-sorted. API Docs Guide

If provided, this function will be called with an updaterFn when state.columnFilters changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. API Docs Guide

If provided, this function will be called with an updaterFn when state.columnOrder changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. API Docs Guide

If provided, this function will be called with an updaterFn when state.columnPinning changes. This overrides the default internal state management, so you will also need to supply state.columnPinning from your own managed state. API Docs Guide

If provided, this function will be called with an updaterFn when state.columnSizing changes. This overrides the default internal state management, so you will also need to supply state.columnSizing from your own managed state. API Docs Guide

If provided, this function will be called with an updaterFn when state.columnSizingInfo changes. This overrides the default internal state management, so you will also need to supply state.columnSizingInfo from your own managed state. API Docs Guide

If provided, this function will be called with an updaterFn when state.columnVisibility changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. API Docs Guide

This function is called when the expanded table state changes. If a function is provided, you will be responsible for managing this state on your own. To pass the managed state back to the table, use the tableOptions.state.expanded option. API Docs Guide

If provided, this function will be called with an updaterFn when state.globalFilter changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. API Docs Guide

If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the tableOptions.state.grouping option. API Docs Guide

If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the tableOptions.state.pagination option. API Docs Guide

If provided, this function will be called with an updaterFn when state.rowPinning changes. This overrides the default internal state management, so you will also need to supply state.rowPinning from your own managed state. API Docs Guide

If provided, this function will be called with an updaterFn when state.rowSelection changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. API Docs Guide

If provided, this function will be called with an updaterFn when state.sorting changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. API Docs Guide

When manually controlling pagination, you can supply a total pageCount value to the table if you know it (Or supply a rowCount and pageCount will be calculated). If you do not know how many pages there are, you can set this to -1. API Docs Guide

If true expanded rows will be paginated along with the rest of the table (which means expanded rows may span multiple pages). If false expanded rows will not be considered for pagination (which means expanded rows will always render on their parents page. This also means more rows will be rendered than the set page size) API Docs Guide

When manually controlling pagination, you can supply a total rowCount value to the table if you know it. The pageCount can be calculated from this value and the pageSize. API Docs Guide

If true, all sorts will default to descending as their first toggle state. API Docs Guide