Zeilenauswahl-APIs

Zustand

Der Zustand der Zeilenauswahl wird in der Tabelle mit der folgenden Struktur gespeichert

tsx

export type RowSelectionState = Record<string, boolean>

export type RowSelectionTableState = {
  rowSelection: RowSelectionState
}

export type RowSelectionState = Record<string, boolean>

export type RowSelectionTableState = {
  rowSelection: RowSelectionState
}

Standardmäßig verwendet der Zustand der Zeilenauswahl den Index jeder Zeile als Zeilenidentifikator. Der Zustand der Zeilenauswahl kann stattdessen mit einer benutzerdefinierten eindeutigen Zeilen-ID verfolgt werden, indem eine benutzerdefinierte getRowId-Funktion an die Tabelle übergeben wird.

Tabellenoptionen

enableRowSelection

tsx

enableRowSelection?: boolean | ((row: Row<TData>) => boolean)

enableRowSelection?: boolean | ((row: Row<TData>) => boolean)

Aktiviert/deaktiviert die Zeilenauswahl für alle Zeilen in der Tabelle ODER
Eine Funktion, die, wenn eine Zeile übergeben wird, zurückgibt, ob die Zeilenauswahl für diese Zeile aktiviert/deaktiviert werden soll

enableMultiRowSelection

tsx

enableMultiRowSelection?: boolean | ((row: Row<TData>) => boolean)

enableMultiRowSelection?: boolean | ((row: Row<TData>) => boolean)

Aktiviert/deaktiviert die Mehrfachzeilenauswahl für alle Zeilen in der Tabelle ODER
Eine Funktion, die, wenn eine Zeile übergeben wird, zurückgibt, ob die Mehrfachzeilenauswahl für die Kinder/Enkelkinder dieser Zeile aktiviert/deaktiviert werden soll

enableSubRowSelection

tsx

enableSubRowSelection?: boolean | ((row: Row<TData>) => boolean)

enableSubRowSelection?: boolean | ((row: Row<TData>) => boolean)

Aktiviert/deaktiviert die automatische Auswahl von Unterzeilen, wenn eine übergeordnete Zeile ausgewählt wird, oder eine Funktion, die die automatische Auswahl von Unterzeilen für jede Zeile aktiviert/deaktiviert.

(Verwendung in Kombination mit erweiterbaren oder gruppierenden Funktionen)

onRowSelectionChange

tsx

onRowSelectionChange?: OnChangeFn<RowSelectionState>

onRowSelectionChange?: OnChangeFn<RowSelectionState>

Wenn angegeben, wird diese Funktion mit einem updaterFn aufgerufen, wenn sich state.rowSelection ändert. Dies überschreibt die interne Standardzustandsverwaltung, sodass Sie die Zustandsänderung entweder vollständig oder teilweise außerhalb der Tabelle speichern müssen.

Tabellen-API

getToggleAllRowsSelectedHandler

tsx

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

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

Gibt einen Handler zurück, der zum Umschalten aller Zeilen in der Tabelle verwendet werden kann.

getToggleAllPageRowsSelectedHandler

tsx

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

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

Gibt einen Handler zurück, der zum Umschalten aller Zeilen auf der aktuellen Seite verwendet werden kann.

setRowSelection

tsx

setRowSelection: (updater: Updater<RowSelectionState>) => void

setRowSelection: (updater: Updater<RowSelectionState>) => void

Setzt oder aktualisiert den state.rowSelection-Zustand.

resetRowSelection

tsx

resetRowSelection: (defaultState?: boolean) => void

resetRowSelection: (defaultState?: boolean) => void

Setzt den rowSelection-Zustand auf den initialState.rowSelection zurück, oder es kann true übergeben werden, um einen Standard-Leerzustands-Reset auf {} zu erzwingen.

getIsAllRowsSelected

tsx

getIsAllRowsSelected: () => boolean

getIsAllRowsSelected: () => boolean

Gibt zurück, ob alle Zeilen in der Tabelle ausgewählt sind.

getIsAllPageRowsSelected

tsx

getIsAllPageRowsSelected: () => boolean

getIsAllPageRowsSelected: () => boolean

Gibt zurück, ob alle Zeilen auf der aktuellen Seite ausgewählt sind.

getIsSomeRowsSelected

tsx

getIsSomeRowsSelected: () => boolean

getIsSomeRowsSelected: () => boolean

Gibt zurück, ob überhaupt Zeilen in der Tabelle ausgewählt sind.

getIsSomePageRowsSelected

tsx

getIsSomePageRowsSelected: () => boolean

getIsSomePageRowsSelected: () => boolean

Gibt zurück, ob überhaupt Zeilen auf der aktuellen Seite ausgewählt sind.

toggleAllRowsSelected

tsx

toggleAllRowsSelected: (value: boolean) => void

toggleAllRowsSelected: (value: boolean) => void

Wählt alle Zeilen in der Tabelle aus/ab.

toggleAllPageRowsSelected

tsx

toggleAllPageRowsSelected: (value: boolean) => void

toggleAllPageRowsSelected: (value: boolean) => void

Wählt alle Zeilen auf der aktuellen Seite aus/ab.

getPreSelectedRowModel

tsx

getPreSelectedRowModel: () => RowModel<TData>

getPreSelectedRowModel: () => RowModel<TData>

getSelectedRowModel

tsx

getSelectedRowModel: () => RowModel<TData>

getSelectedRowModel: () => RowModel<TData>

getFilteredSelectedRowModel

tsx

getFilteredSelectedRowModel: () => RowModel<TData>

getFilteredSelectedRowModel: () => RowModel<TData>

getGroupedSelectedRowModel

tsx

getGroupedSelectedRowModel: () => RowModel<TData>

getGroupedSelectedRowModel: () => RowModel<TData>

Zeilen-API

getIsSelected

tsx

getIsSelected: () => boolean

getIsSelected: () => boolean

Gibt zurück, ob die Zeile ausgewählt ist.

getIsSomeSelected

tsx

getIsSomeSelected: () => boolean

getIsSomeSelected: () => boolean

Gibt zurück, ob einige der Unterzeilen der Zeile ausgewählt sind.

getIsAllSubRowsSelected

tsx

getIsAllSubRowsSelected: () => boolean

getIsAllSubRowsSelected: () => boolean

Gibt zurück, ob alle Unterzeilen der Zeile ausgewählt sind.

getCanSelect

tsx

getCanSelect: () => boolean

getCanSelect: () => boolean

Gibt zurück, ob die Zeile ausgewählt werden kann.

getCanMultiSelect

tsx

getCanMultiSelect: () => boolean

getCanMultiSelect: () => boolean

Gibt zurück, ob die Zeile Mehrfachauswahl durchführen kann.

getCanSelectSubRows

tsx

getCanSelectSubRows: () => boolean

getCanSelectSubRows: () => boolean

Gibt zurück, ob die Zeile automatisch Unterzeilen auswählen kann, wenn die übergeordnete Zeile ausgewählt ist.

toggleSelected

tsx

toggleSelected: (value?: boolean) => void

toggleSelected: (value?: boolean) => void

Wählt die Zeile aus/ab.

getToggleSelectedHandler

tsx

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

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

Gibt einen Handler zurück, der zum Umschalten der Zeile verwendet werden kann.