TinyBase logoTinyBase β

useResultSortedRowIds

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

useResultSortedRowIds(
  queryId: MaybeGetter<string>,
  cellId?: MaybeGetter<undefined | string>,
  descending?: MaybeGetter<boolean>,
  offset?: MaybeGetter<number>,
  limit?: MaybeGetter<undefined | number>,
  queriesOrQueriesId?: MaybeGetter<undefined | QueriesOrQueriesId>,
): {current: Ids}
TypeDescription
queryIdMaybeGetter<string>

The Id of the Query (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 (or a getter returning it).

queriesOrQueriesId?MaybeGetter<undefined | QueriesOrQueriesId>

The Queries object to use (plain or getter), or its Id.

returns{current: Ids}

A reactive object with a current Ids property.

Since

v8.1.0