Framework
Version
Enterprise

Pagination APIs

Zustand

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

tsx
export type PaginationState = {
  pageIndex: number
  pageSize: number
}

export type PaginationTableState = {
  pagination: PaginationState
}

export type PaginationInitialTableState = {
  pagination?: Partial<PaginationState>
}
export type PaginationState = {
  pageIndex: number
  pageSize: number
}

export type PaginationTableState = {
  pagination: PaginationState
}

export type PaginationInitialTableState = {
  pagination?: Partial<PaginationState>
}

Tabellenoptionen

manuelleSeitennummerierung

tsx
manualPagination?: boolean
manualPagination?: boolean

Ermöglicht die manuelle Seitennummerierung. Wenn diese Option auf true gesetzt ist, paginiert die Tabelle die Zeilen nicht automatisch mit getSeitennummerierungsZeilenModell(), sondern erwartet stattdessen, dass Sie die Zeilen manuell paginieren, bevor Sie sie an die Tabelle übergeben. Dies ist nützlich, wenn Sie serverseitige Seitennummerierung und Aggregation durchführen.

seitenzahl

tsx
pageCount?: number
pageCount?: number

Wenn Sie die Seitennummerierung manuell steuern, können Sie der Tabelle eine Gesamtzahl von seitenzahl Werten übergeben, wenn Sie diese kennen. Wenn Sie nicht wissen, wie viele Seiten es gibt, können Sie diesen Wert auf -1 setzen. Alternativ können Sie einen Wert für anzahlZeilen angeben, und die Tabelle berechnet intern die seitenzahl.

anzahlZeilen

tsx
rowCount?: number
rowCount?: number

Wenn Sie die Seitennummerierung manuell steuern, können Sie der Tabelle eine Gesamtzahl von anzahlZeilen Werten übergeben, wenn Sie diese kennen. Die seitenzahl wird intern aus anzahlZeilen und seitengroesse berechnet.

autoResetSeitenzahlIndex

tsx
autoResetPageIndex?: boolean
autoResetPageIndex?: boolean

Wenn auf true gesetzt, wird die Seitennummerierung bei seitenverändernden Zustandsänderungen wie z. B. der Aktualisierung von daten, Filteränderungen, Gruppenänderungen usw. zur ersten Seite zurückgesetzt.

🧠 Hinweis: Diese Option ist standardmäßig auf false gesetzt, wenn manuelleSeitennummerierung auf true gesetzt ist

onSeitennummerierungChange

tsx
onPaginationChange?: OnChangeFn<PaginationState>
onPaginationChange?: OnChangeFn<PaginationState>

Wenn diese Funktion bereitgestellt wird, wird sie aufgerufen, wenn sich der Zustand der Seitennummerierung ändert, und Sie müssen den Zustand selbst verwalten. Sie können den verwalteten Zustand über die Option tableOptions.state.pagination zurück an die Tabelle übergeben.

getSeitennummerierungsZeilenModell

tsx
getPaginationRowModel?: (table: Table<TData>) => () => RowModel<TData>
getPaginationRowModel?: (table: Table<TData>) => () => RowModel<TData>

Gibt das Zeilenmodell zurück, nachdem die Seitennummerierung stattgefunden hat, aber nicht weiter.

Die Spalten für die Seitennummerierung werden standardmäßig automatisch an den Anfang der Spaltenliste verschoben. Wenn Sie sie lieber entfernen oder unverändert lassen möchten, setzen Sie hier den entsprechenden Modus.

Tabellen-API

setSeitennummerierung

tsx
setPagination: (updater: Updater<PaginationState>) => void
setPagination: (updater: Updater<PaginationState>) => void

Legt den Zustand state.pagination fest oder aktualisiert ihn.

resetSeitennummerierung

tsx
resetPagination: (defaultState?: boolean) => void
resetPagination: (defaultState?: boolean) => void

Setzt den Zustand der **Seitennummerierung** auf initialState.pagination zurück, oder es kann true übergeben werden, um einen standardmäßigen leeren Zustand auf [] zurückzusetzen.

setSeitenzahlIndex

tsx
setPageIndex: (updater: Updater<number>) => void
setPageIndex: (updater: Updater<number>) => void

Aktualisiert den Seitenindex mithilfe der bereitgestellten Funktion oder des bereitgestellten Werts.

resetSeitenzahlIndex

tsx
resetPageIndex: (defaultState?: boolean) => void
resetPageIndex: (defaultState?: boolean) => void

Setzt den Seitenindex auf seinen ursprünglichen Zustand zurück. Wenn defaultState true ist, wird der Seitenindex unabhängig vom ursprünglichen Zustand auf 0 zurückgesetzt.

setSeitengroesse

tsx
setPageSize: (updater: Updater<number>) => void
setPageSize: (updater: Updater<number>) => void

Aktualisiert die Seitengröße mithilfe der bereitgestellten Funktion oder des bereitgestellten Werts.

resetSeitengroesse

tsx
resetPageSize: (defaultState?: boolean) => void
resetPageSize: (defaultState?: boolean) => void

Setzt die Seitengröße auf ihren ursprünglichen Zustand zurück. Wenn defaultState true ist, wird die Seitengröße unabhängig vom ursprünglichen Zustand auf 10 zurückgesetzt.

getSeitenOptionen

tsx
getPageOptions: () => number[]
getPageOptions: () => number[]

Gibt ein Array von Seitenoptionen (nullbasiert) für die aktuelle Seitengröße zurück.

getKannVorherigeSeite

tsx
getCanPreviousPage: () => boolean
getCanPreviousPage: () => boolean

Gibt zurück, ob die Tabelle zur vorherigen Seite wechseln kann.

getKannNaechsteSeite

tsx
getCanNextPage: () => boolean
getCanNextPage: () => boolean

Gibt zurück, ob die Tabelle zur nächsten Seite wechseln kann.

vorherigeSeite

tsx
previousPage: () => void
previousPage: () => void

Dekrementiert den Seitenindex um eins, wenn möglich.

naechsteSeite

tsx
nextPage: () => void
nextPage: () => void

Inkrementiert den Seitenindex um eins, wenn möglich.

ersteSeite

tsx
firstPage: () => void
firstPage: () => void

Setzt den Seitenindex auf 0.

letzteSeite

tsx
lastPage: () => void
lastPage: () => void

Setzt den Seitenindex auf die letzte verfügbare Seite.

getSeitenanzahl

tsx
getPageCount: () => number
getPageCount: () => number

Gibt die Anzahl der Seiten zurück. Bei manueller Seitennummerierung oder Steuerung des Seitennummerierungszustands stammt dieser Wert direkt aus der Tabellenoption options.pageCount, andernfalls wird er anhand der Tabellendaten aus der Gesamtzahl der Zeilen und der aktuellen Seitengröße berechnet.

getVorSeitennummerierungsZeilenModell

tsx
getPrePaginationRowModel: () => RowModel<TData>
getPrePaginationRowModel: () => RowModel<TData>

Gibt das Zeilenmodell für die Tabelle zurück, bevor die Seitennummerierung angewendet wurde.

getSeitennummerierungsZeilenModell

tsx
getPaginationRowModel: () => RowModel<TData>
getPaginationRowModel: () => RowModel<TData>

Gibt das Zeilenmodell für die Tabelle zurück, nachdem die Seitennummerierung angewendet wurde.

Unsere Partner
Code Rabbit
AG Grid
Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.

Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.