VVibeFlui

Table Persistence

Table state can be persisted with persist.

Persist all table state

TS
export const ordersSchema = {
  resource: "orders",
  persist: {
    search: true,
    filter: true,
    sort: true,
    page: true,
    columnVisibility: true,
    storage: "localStorage"
  }
} as const;

Persisted fields

PropertyPersisted state
searchGlobal search text.
filterColumn filter values.
sortFirst sort key and direction.
pageCurrent page and page size.
columnVisibilityVisible/hidden column map.

Storage

TS
persist: {
  search: true,
  storage: "sessionStorage"
}

Supported storage values:

  • localStorage
  • sessionStorage
  • url

Default storage is localStorage.

Custom key

TS
persist: {
  search: true,
  filter: true,
  key: "admin:users:table"
}

Default key:

TXT
fluikit:{resource}:table

URL storage

When storage: "url" is used, VibeFlui stores JSON state in a query parameter using the persistence key.

TS
persist: {
  search: true,
  filter: true,
  sort: true,
  page: true,
  columnVisibility: true,
  storage: "url"
}