kotlin-tanstack-table-core/tanstack.table.core

Package-level declarations

Types

external interface AccessorColumnDef<TData : RowData, TValue> : AccessorKeyColumnDef<TData, TValue> , AccessorFnColumnDef<TData, TValue>

AccessorFn

typealias AccessorFn<TData, TValue> = (originalRow: TData, index: Int) -> TValue

AccessorFnColumnDef

external interface AccessorFnColumnDef<TData : RowData, TValue> : AccessorFnColumnDefBase<TData, TValue> , ColumnIdentifiers<TData, TValue>

AccessorFnColumnDefBase

external interface AccessorFnColumnDefBase<TData : RowData, TValue> : ColumnDefBase<TData, TValue>

AccessorKeyColumnDef

external interface AccessorKeyColumnDef<TData : RowData, TValue> : AccessorKeyColumnDefBase<TData, TValue> , ColumnIdentifiers<TData, TValue>

AccessorKeyColumnDefBase

external interface AccessorKeyColumnDefBase<TData : RowData, TValue> : ColumnDefBase<TData, TValue>

AggregationFn

typealias AggregationFn<TData> = (columnId: String, @R|kotlin/ParameterName|(name = String(leafRows)) ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>, @R|kotlin/ParameterName|(name = String(childRows)) ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>) -> Any

AggregationFnOption

sealed external interface AggregationFnOption<TData : RowData>

AggregationFns

external interface AggregationFns

aggregationFns

external object aggregationFns

AnyFunction

typealias AnyFunction = Function<Unit>

AnyRender

typealias AnyRender = (Comp: Any, props: Any) -> Any

Cell

external interface Cell<TData : RowData, TValue> : CoreCell<TData, TValue> , GroupingCell

CellContext

external interface CellContext<TData : RowData, TValue>

Column

external interface Column<TData : RowData, TValue> : CoreColumn<TData, TValue> , VisibilityColumn, ColumnPinningColumn, FacetedColumn<TData> , ColumnFiltersColumn<TData> , GlobalFilterColumn, SortingColumn<TData> , GroupingColumn<TData> , ColumnSizingColumn, ColumnOrderColumn

ColumnDef

external interface ColumnDef<TData : RowData, TValue> : DisplayColumnDef<TData, TValue> , GroupColumnDef<TData, TValue> , AccessorColumnDef<TData, TValue>

ColumnDefaultOptions

external interface ColumnDefaultOptions

ColumnDefBase

external interface ColumnDefBase<TData : RowData, TValue> : ColumnDefExtensions<TData, TValue>

ColumnDefExtensions

external interface ColumnDefExtensions<TData : RowData, TValue> : VisibilityColumnDef, ColumnPinningColumnDef, ColumnFiltersColumnDef<TData> , GlobalFilterColumnDef, SortingColumnDef<TData> , GroupingColumnDef<TData, TValue> , ColumnSizingColumnDef

ColumnDefResolved

external interface ColumnDefResolved<TData : RowData, TValue> : ColumnDef<TData, TValue>

ColumnDefTemplate

sealed external interface ColumnDefTemplate<TProps : Any>

ColumnFilter

external interface ColumnFilter

ColumnFilterAutoRemoveTestFn

typealias ColumnFilterAutoRemoveTestFn<TData> = (value: Any, column: Column<TData, *>?) -> Boolean

ColumnFiltersColumn

external interface ColumnFiltersColumn<TData : RowData>

ColumnFiltersColumnDef

external interface ColumnFiltersColumnDef<TData : RowData>

ColumnFiltersInstance

external interface ColumnFiltersInstance<TData : RowData>

ColumnFiltersOptions

external interface ColumnFiltersOptions<TData : RowData> : ColumnFiltersOptionsBase<TData> , ResolvedFilterFns

ColumnFiltersOptionsBase

external interface ColumnFiltersOptionsBase<TData : RowData>

ColumnFiltersRow

external interface ColumnFiltersRow<TData : RowData>

ColumnFiltersState

typealias ColumnFiltersState = ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/ColumnFilter>

ColumnFiltersTableState

external interface ColumnFiltersTableState

ColumnIdentifiers

external interface ColumnIdentifiers<TData : RowData, TValue> : IdIdentifier<TData, TValue>

ColumnMeta

external interface ColumnMeta<TData : RowData, TValue>

ColumnOrderColumn

external interface ColumnOrderColumn

ColumnOrderDefaultOptions

external interface ColumnOrderDefaultOptions

ColumnOrderInstance

external interface ColumnOrderInstance<TData : RowData>

ColumnOrderOptions

external interface ColumnOrderOptions

ColumnOrderPosition

sealed external interface ColumnOrderPosition

ColumnOrderState

typealias ColumnOrderState = ERROR CLASS: Symbol not found for ReadonlyArray<kotlin/String>

ColumnOrderTableState

external interface ColumnOrderTableState

ColumnPinningColumn

external interface ColumnPinningColumn

ColumnPinningColumnDef

external interface ColumnPinningColumnDef

ColumnPinningDefaultOptions

external interface ColumnPinningDefaultOptions

ColumnPinningInstance

external interface ColumnPinningInstance<TData : RowData>

ColumnPinningOptions

external interface ColumnPinningOptions

ColumnPinningPosition

sealed external interface ColumnPinningPosition

ColumnPinningRow

external interface ColumnPinningRow<TData : RowData>

ColumnPinningState

external interface ColumnPinningState

ColumnPinningTableState

external interface ColumnPinningTableState

ColumnResizeDirection

sealed external interface ColumnResizeDirection

ColumnResizeMode

sealed external interface ColumnResizeMode

ColumnSizingColumn

external interface ColumnSizingColumn

ColumnSizingColumnDef

external interface ColumnSizingColumnDef

ColumnSizingDefaultOptions

external interface ColumnSizingDefaultOptions : ColumnSizingOptions

ColumnSizingHeader

external interface ColumnSizingHeader

ColumnSizingInfoState

external interface ColumnSizingInfoState

ColumnSizingInstance

external interface ColumnSizingInstance

ColumnSizingOptions

external interface ColumnSizingOptions

ColumnSizingState

typealias ColumnSizingState = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Int>

ColumnSizingTableState

external interface ColumnSizingTableState

ColumnSort

external interface ColumnSort

CompleteInitialTableState

external interface CompleteInitialTableState : CoreTableState, VisibilityTableState, ColumnOrderTableState, ColumnPinningTableState, RowPinningTableState, ColumnFiltersTableState, GlobalFilterTableState, SortingTableState, ExpandedTableState, GroupingTableState, ColumnSizingTableState, PaginationInitialTableState, RowSelectionTableState

CoreCell

external interface CoreCell<TData : RowData, TValue>

CoreColumn

external interface CoreColumn<TData : RowData, TValue>

CoreHeader

external interface CoreHeader<TData : RowData, TValue>

CoreHeaderGroup

external interface CoreHeaderGroup<TData : RowData>

CoreInstance

external interface CoreInstance<TData : RowData>

CoreOptions

external interface CoreOptions<TData : RowData>

CoreOptionsResolved

external interface CoreOptionsResolved<TData : RowData> : CoreOptions<TData>

CoreRow

external interface CoreRow<TData : RowData>

CoreTableState

external interface CoreTableState

CustomAggregationFns

typealias CustomAggregationFns = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, tanstack/table/core/AggregationFn<*>>

CustomFilterFns

typealias CustomFilterFns<TData> = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, tanstack/table/core/FilterFn<TData>>

CustomSortingFns

typealias CustomSortingFns<TData> = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, tanstack/table/core/SortingFn<TData>>

defaultColumnSizing

external object defaultColumnSizing

DisplayColumnDef

external interface DisplayColumnDef<TData : RowData, TValue> : ColumnDefBase<TData, TValue> , ColumnIdentifiers<TData, TValue>

ExpandedInstance

external interface ExpandedInstance<TData : RowData>

ExpandedOptions

external interface ExpandedOptions<TData : RowData>

ExpandedRow

external interface ExpandedRow

ExpandedState

sealed external interface ExpandedState

ExpandedStateList

typealias ExpandedStateList = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>

ExpandedTableState

external interface ExpandedTableState

FacetedColumn

external interface FacetedColumn<TData : RowData>

FacetedOptions

external interface FacetedOptions<TData : RowData>

FeatureOptions

external interface FeatureOptions<TData : RowData> : VisibilityOptions, ColumnOrderOptions, ColumnPinningOptions, RowPinningOptions<TData> , FacetedOptions<TData> , ColumnFiltersOptions<TData> , GlobalFilterOptions<TData> , SortingOptions<TData> , GroupingOptions<TData> , ExpandedOptions<TData> , ColumnSizingOptions, PaginationOptions<TData> , RowSelectionOptions<TData>

FilterFn

external interface FilterFn<TData : RowData>

FilterFnOption

sealed external interface FilterFnOption<TData : RowData>

FilterFns

external interface FilterFns

filterFns

external object filterFns

FilterMeta

external interface FilterMeta

Getter

typealias Getter<TValue> = () -> TValue

GlobalFacetingInstance

external interface GlobalFacetingInstance<TData : RowData>

GlobalFilterColumn

external interface GlobalFilterColumn

GlobalFilterColumnDef

external interface GlobalFilterColumnDef

GlobalFilterInstance

external interface GlobalFilterInstance<TData : RowData>

GlobalFilterOptions

external interface GlobalFilterOptions<TData : RowData>

GlobalFilterTableState

external interface GlobalFilterTableState

GroupColumnDef

external interface GroupColumnDef<TData : RowData, TValue> : GroupColumnDefBase<TData, TValue> , ColumnIdentifiers<TData, TValue>

GroupColumnDefBase

external interface GroupColumnDefBase<TData : RowData, TValue> : ColumnDefBase<TData, TValue>

GroupingCell

external interface GroupingCell

GroupingColumn

external interface GroupingColumn<TData : RowData>

GroupingColumnDef

external interface GroupingColumnDef<TData : RowData, TValue>

GroupingColumnMode

sealed external interface GroupingColumnMode

GroupingInstance

external interface GroupingInstance<TData : RowData>

GroupingOptions

external interface GroupingOptions<TData : RowData> : GroupingOptionsBase<TData> , ResolvedAggregationFns

GroupingOptionsBase

external interface GroupingOptionsBase<TData : RowData>

GroupingRow

external interface GroupingRow

GroupingState

typealias GroupingState = ERROR CLASS: Symbol not found for ReadonlyArray<kotlin/String>

GroupingTableState

external interface GroupingTableState

Header

external interface Header<TData : RowData, TValue> : CoreHeader<TData, TValue> , ColumnSizingHeader

HeaderContext

external interface HeaderContext<TData : RowData, TValue>

HeaderGroup

external interface HeaderGroup<TData : RowData> : CoreHeaderGroup<TData>

HeadersInstance

external interface HeadersInstance<TData : RowData>

IdentifiedColumnDef

external interface IdentifiedColumnDef<TData : RowData, TValue> : ColumnDefBase<TData, TValue>

IdIdentifier

external interface IdIdentifier<TData : RowData, TValue>

InitialTableState

external interface InitialTableState : CompleteInitialTableState

OnChangeFn

sealed external interface OnChangeFn<T>

PaginationDefaultOptions

external interface PaginationDefaultOptions

PaginationInitialTableState

external interface PaginationInitialTableState

PaginationInstance

external interface PaginationInstance<TData : RowData>

PaginationOptions

external interface PaginationOptions<TData : RowData>

PaginationState

external interface PaginationState

PaginationTableState

external interface PaginationTableState

ResolvedAggregationFns

external interface ResolvedAggregationFns

ResolvedColumnFilter

external interface ResolvedColumnFilter<TData : RowData>

ResolvedFilterFns

external interface ResolvedFilterFns

ResolvedSortingFns

external interface ResolvedSortingFns

Row

external interface Row<TData : RowData> : CoreRow<TData> , VisibilityRow<TData> , ColumnPinningRow<TData> , RowPinningRow, ColumnFiltersRow<TData> , GroupingRow, RowSelectionRow, ExpandedRow

RowData

typealias RowData = Any

RowModel

external interface RowModel<TData : RowData>

RowPinningDefaultOptions

external interface RowPinningDefaultOptions

RowPinningInstance

external interface RowPinningInstance<TData : RowData>

RowPinningOptions

external interface RowPinningOptions<TData : RowData>

RowPinningPosition

sealed external interface RowPinningPosition

RowPinningRow

external interface RowPinningRow

RowPinningState

external interface RowPinningState

RowPinningTableState

external interface RowPinningTableState

RowSelectionInstance

external interface RowSelectionInstance<TData : RowData>

RowSelectionOptions

external interface RowSelectionOptions<TData : RowData>

RowSelectionRow

external interface RowSelectionRow

RowSelectionState

typealias RowSelectionState = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>

RowSelectionTableState

external interface RowSelectionTableState

SortDirection

sealed external interface SortDirection

SortingColumn

external interface SortingColumn<TData : RowData>

SortingColumnDef

external interface SortingColumnDef<TData : RowData>

SortingFn

external interface SortingFn<TData : RowData>

SortingFnOption

sealed external interface SortingFnOption<TData : RowData>

SortingFns

external interface SortingFns

sortingFns

external object sortingFns

SortingInstance

external interface SortingInstance<TData : RowData>

SortingOptions

external interface SortingOptions<TData : RowData> : SortingOptionsBase<TData> , ResolvedSortingFns

SortingOptionsBase

external interface SortingOptionsBase<TData : RowData>

SortingState

typealias SortingState = ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/ColumnSort>

SortingTableState

external interface SortingTableState

StringHeaderIdentifier

external interface StringHeaderIdentifier

StringOrTemplateHeader

sealed external interface StringOrTemplateHeader<TData : RowData, TValue>

Table

external interface Table<TData : RowData> : CoreInstance<TData> , HeadersInstance<TData> , VisibilityInstance<TData> , ColumnOrderInstance<TData> , ColumnPinningInstance<TData> , RowPinningInstance<TData> , ColumnFiltersInstance<TData> , GlobalFilterInstance<TData> , GlobalFacetingInstance<TData> , SortingInstance<TData> , GroupingInstance<TData> , ColumnSizingInstance, ExpandedInstance<TData> , PaginationInstance<TData> , RowSelectionInstance<TData>

TableFeature

external interface TableFeature<TData : RowData>

TableMeta

typealias TableMeta = ERROR CLASS: Symbol not found for ReadonlyRecord<ERROR CLASS: Symbol not found for PropertyKey, kotlin/Any>

TableOptions

external interface TableOptions<TData : RowData> : CoreOptions<TData> , FeatureOptions<TData>

TableOptionsResolved

external interface TableOptionsResolved<TData : RowData> : CoreOptionsResolved<TData> , FeatureOptions<TData>

TableState

external interface TableState : CoreTableState, VisibilityTableState, ColumnOrderTableState, ColumnPinningTableState, RowPinningTableState, ColumnFiltersTableState, GlobalFilterTableState, SortingTableState, ExpandedTableState, GroupingTableState, ColumnSizingTableState, PaginationTableState, RowSelectionTableState

TransformFilterValueFn

typealias TransformFilterValueFn<TData> = (value: Any, column: Column<TData, *>?) -> Any

Updater

sealed external interface Updater<T>

VisibilityColumn

external interface VisibilityColumn

VisibilityColumnDef

external interface VisibilityColumnDef

VisibilityDefaultOptions

external interface VisibilityDefaultOptions : VisibilityOptions

VisibilityInstance

external interface VisibilityInstance<TData : RowData>

VisibilityOptions

external interface VisibilityOptions

VisibilityRow

external interface VisibilityRow<TData : RowData>

VisibilityState

typealias VisibilityState = ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>

VisibilityTableState

external interface VisibilityTableState

Properties

ColumnFaceting

external val ColumnFaceting: TableFeature<*>

ColumnFiltering

external val ColumnFiltering: TableFeature<*>

ColumnGrouping

external val ColumnGrouping: TableFeature<*>

ColumnOrdering

external val ColumnOrdering: TableFeature<*>

ColumnPinning

external val ColumnPinning: TableFeature<*>

ColumnSizing

external val ColumnSizing: TableFeature<*>

ColumnVisibility

external val ColumnVisibility: TableFeature<*>

GlobalFaceting

external val GlobalFaceting: TableFeature<*>

GlobalFiltering

external val GlobalFiltering: TableFeature<*>

Headers

external val Headers: TableFeature<*>

reSplitAlphaNumeric

external val reSplitAlphaNumeric: ERROR CLASS: Symbol not found for RegExp

RowExpanding

external val RowExpanding: TableFeature<*>

RowPagination

external val RowPagination: TableFeature<*>

RowPinning

external val RowPinning: TableFeature<*>

RowSelection

external val RowSelection: TableFeature<*>

RowSorting

external val RowSorting: TableFeature<*>

Functions

AggregationFnOption

inline fun <TData : RowData> AggregationFnOption(noinline source: AggregationFn<TData>): AggregationFnOption<TData>

inline fun <TData : RowData> AggregationFnOption(source: String): AggregationFnOption<TData>

buildHeaderGroups

external fun <TData : RowData> buildHeaderGroups(allColumns: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Column<TData, *>>, columnsToGroup: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Column<TData, *>>, table: Table<TData>, headerFamily: String = definedExternally): ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/HeaderGroup<TData>>

ColumnDefTemplate

inline fun <TProps : Any> ColumnDefTemplate(noinline source: (props: TProps) -> Any?): ColumnDefTemplate<TProps>

inline fun <TProps : Any> ColumnDefTemplate(source: String): ColumnDefTemplate<TProps>

createCell

external fun <TData : RowData, TValue> createCell(table: Table<TData>, row: Row<TData>, column: Column<TData, TValue>, columnId: String): Cell<TData, TValue>

createColumn

external fun <TData : RowData, TValue> createColumn(table: Table<TData>, columnDef: ColumnDef<TData, TValue>, depth: Int, parent: Column<TData, TValue> = definedExternally): Column<TData, TValue>

createRow

external fun <TData : RowData> createRow(table: Table<TData>, id: String, original: TData, rowIndex: Int, depth: Int, subRows: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>?? = definedExternally, parentId: String? = definedExternally): Row<TData>

createTable

external fun <TData : RowData> createTable(options: TableOptionsResolved<TData>): Table<TData>

ExpandedState

inline fun ExpandedState(source: ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>): ExpandedState

inline fun ExpandedState(source: Boolean): ExpandedState

expandRows

external fun <TData : RowData> expandRows(rowModel: RowModel<TData>): Any

FilterFnOption

inline fun <TData : RowData> FilterFnOption(source: String): FilterFnOption<TData>

inline fun <TData : RowData> FilterFnOption(source: FilterFn<TData>): FilterFnOption<TData>

filterRows

external fun <TData : RowData> filterRows(rows: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>, filterRowImpl: (row: Row<TData>) -> Boolean, table: Table<TData>): RowModel<TData>

flattenBy

external fun <TNode> flattenBy(arr: ERROR CLASS: Symbol not found for ReadonlyArray<TNode>, getChildren: (item: TNode) -> ERROR CLASS: Symbol not found for ReadonlyArray<TNode>): ERROR CLASS: Symbol not found for ReadonlyArray<TNode>

functionalUpdate

external fun <T> functionalUpdate(updater: Updater<T>, input: T): T

getCoreRowModel

external fun <TData : RowData> getCoreRowModel(): (table: Table<TData>) -> () -> RowModel<TData>

getExpandedRowModel

external fun <TData : RowData> getExpandedRowModel(): (table: Table<TData>) -> () -> RowModel<TData>

getFacetedMinMaxValues

external fun <TData : RowData> getFacetedMinMaxValues(): (table: Table<TData>, columnId: String) -> () -> ERROR CLASS: Symbol not found for Tuple2<kotlin/Int, kotlin/Int>??

getFacetedRowModel

external fun <TData : RowData> getFacetedRowModel(): (table: Table<TData>, columnId: String) -> () -> RowModel<TData>

getFacetedUniqueValues

external fun <TData : RowData> getFacetedUniqueValues(): (table: Table<TData>, columnId: String) -> () -> ERROR CLASS: Symbol not found for JsMap<kotlin/Any, kotlin/Int>

getFilteredRowModel

external fun <TData : RowData> getFilteredRowModel(): (table: Table<TData>) -> () -> RowModel<TData>

getGroupedRowModel

external fun <TData : RowData> getGroupedRowModel(): (table: Table<TData>) -> () -> RowModel<TData>

getPaginationRowModel

external fun <TData : RowData> getPaginationRowModel(opts: Any = definedExternally): (table: Table<TData>) -> () -> RowModel<TData>

getSortedRowModel

external fun <TData : RowData> getSortedRowModel(): (table: Table<TData>) -> () -> RowModel<TData>

isRowSelected

external fun <TData : RowData> isRowSelected(row: Row<TData>, selection: ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>): Boolean

isSubRowSelected

external fun <TData : RowData> isSubRowSelected(row: Row<TData>, selection: ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>, table: Table<TData>): Any

noop

external fun noop()

OnChangeFn

inline fun <T> OnChangeFn(noinline source: (updaterOrValue: Updater<T>) -> Unit): OnChangeFn<T>

orderColumns

external fun <TData : RowData> orderColumns(leafColumns: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Column<TData, *>>, grouping: ERROR CLASS: Symbol not found for ReadonlyArray<kotlin/String>, groupedColumnMode: GroupingColumnMode = definedExternally): ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Column<TData, *>>

passiveEventSupported

external fun passiveEventSupported(): Boolean

safelyAccessDocument

external fun safelyAccessDocument(_document: ERROR CLASS: Symbol not found for Document?? = definedExternally): ERROR CLASS: Symbol not found for Document??

safelyAccessDocumentEvent

external fun safelyAccessDocumentEvent(event: ERROR CLASS: Symbol not found for Event): ERROR CLASS: Symbol not found for Document??

selectRowsFn

external fun <TData : RowData> selectRowsFn(table: Table<TData>, rowModel: RowModel<TData>): RowModel<TData>

shouldAutoRemoveFilter

external fun <TData : RowData> shouldAutoRemoveFilter(filterFn: FilterFn<TData> = definedExternally, value: Any = definedExternally, column: Column<TData, *> = definedExternally): Boolean

SortingFnOption

inline fun <TData : RowData> SortingFnOption(source: String): SortingFnOption<TData>

inline fun <TData : RowData> SortingFnOption(source: SortingFn<TData>): SortingFnOption<TData>

StringOrTemplateHeader

inline fun <TData : RowData, TValue> StringOrTemplateHeader(source: String): StringOrTemplateHeader<TData, TValue>

inline fun <TData : RowData, TValue> StringOrTemplateHeader(source: ColumnDefTemplate<HeaderContext<TData, TValue>>): StringOrTemplateHeader<TData, TValue>

Updater

inline fun <T> Updater(source: T): Updater<T>

inline fun <T> Updater(noinline source: (old: T) -> T): Updater<T>