TinyBase logoTinyBase β

useSortedRowIds

The useSortedRowIds hook returns a reactive object reflecting the sorted Row Ids in a Table, and registers a listener so that any changes will update .current.

useSortedRowIds(
  tableId: MaybeGetter<string>,
  cellId?: MaybeGetter<undefined | string>,
  descending?: MaybeGetter<boolean>,
  offset?: MaybeGetter<number>,
  limit?: MaybeGetter<undefined | number>,
  storeOrStoreId?: MaybeGetter<undefined | StoreOrStoreId>,
): {current: Ids}
TypeDescription
tableIdMaybeGetter<string>

The Id of the Table (or a getter returning it).

cellId?MaybeGetter<undefined | string>

The Id of the Cell to sort by (or a getter returning it).

descending?MaybeGetter<boolean>

Whether to sort descending (or a getter returning it).

offset?MaybeGetter<number>

The starting Row offset (or a getter returning it).

limit?MaybeGetter<undefined | number>

The maximum number of Rows to return (or a getter returning it).

storeOrStoreId?MaybeGetter<undefined | StoreOrStoreId>

The Store to use (plain value or getter), or its Id.

returns{current: Ids}

A reactive object with a current Ids property.

Since

v8.1.0