CoreOptions

external interface CoreOptions<TData : RowData>(source)

Inheritors

Properties

Link copied to clipboard
abstract var autoResetAll: Boolean?

Set this option to override any of the autoReset... feature options. API Docs Guide

Link copied to clipboard

The array of column defs to use for the table. API Docs Guide

Link copied to clipboard
abstract var data: ReadonlyArray<TData>

The data for the table to display. This array should match the type you provided to table.setRowType<...>. Columns can access this data via string/index or a functional accessor. When the data option changes reference, the table will reprocess the data. API Docs Guide

Link copied to clipboard
abstract var debugAll: Boolean?

Set this option to true to output all debugging information to the console. API Docs Guide

Link copied to clipboard
abstract var debugCells: Boolean?

Set this option to true to output cell debugging information to the console. API Docs(https://tanstack.com/table/v8/docs/api/core/table#debugcells]

Link copied to clipboard
abstract var debugColumns: Boolean?

Set this option to true to output column debugging information to the console. API Docs Guide

Link copied to clipboard
abstract var debugHeaders: Boolean?

Set this option to true to output header debugging information to the console. API Docs Guide

Link copied to clipboard
abstract var debugRows: Boolean?

Set this option to true to output row debugging information to the console. API Docs Guide

Link copied to clipboard
abstract var debugTable: Boolean?

Set this option to true to output table debugging information to the console. API Docs Guide

Link copied to clipboard
abstract var defaultColumn: ColumnDef<TData, *>?

Default column options to use for all column defs supplied to the table. API Docs Guide

Link copied to clipboard
abstract var getCoreRowModel: (table: Table<TData>) -> () -> RowModel<TData>

This required option is a factory for a function that computes and returns the core row model for the table. API Docs Guide

Link copied to clipboard
abstract var getRowId: (originalRow: TData, index: Int, parent: Row<TData>?) -> String?

This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with . using their grandparents' index eg. index.index.index). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc.

Link copied to clipboard
abstract var getSubRows: (originalRow: TData, index: Int) -> ReadonlyArray<TData>?

This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row.

Link copied to clipboard

Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. options.autoResetPageIndex) or via functions like table.resetRowSelection(). Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state.

Link copied to clipboard
abstract var mergeOptions: (defaultOptions: TableOptions<TData>, options: TableOptions<TData>) -> TableOptions<TData>?

This option is used to optionally implement the merging of table options. API Docs Guide

Link copied to clipboard
abstract var meta: TableMeta<TData>?

You can pass any object to options.meta and access it anywhere the table is available via table.options.meta. API Docs Guide

Link copied to clipboard
abstract var onStateChange: (updater: Updater<TableState>) -> Unit

The onStateChange option can be used to optionally listen to state changes within the table. API Docs Guide

Link copied to clipboard
abstract var renderFallbackValue: Any

Value used when the desired value is not found in the data. API Docs Guide

Link copied to clipboard
abstract var state: TableState

The state option can be used to optionally control part or all of the table state. The state you pass here will merge with and overwrite the internal automatically-managed state to produce the final state for the table. You can also listen to state changes via the onStateChange option.