`useResultSortedRowIds`

The useResultSortedRowIds primitive returns the sorted (and optionally, paginated) Ids of every Row in the ResultTable of the given query, and registers a listener so that any changes to those Ids will cause an update.

useResultSortedRowIds(
  queryId: MaybeAccessor<string>,
  cellId?: MaybeAccessor<undefined | string>,
  descending?: MaybeAccessor<undefined | boolean>,
  offset?: MaybeAccessor<undefined | number>,
  limit?: MaybeAccessor<undefined | number>,
  queriesOrQueriesId?: MaybeAccessor<undefined | QueriesOrQueriesId>,
): Accessor<Ids>

	Type	Description
`queryId`	`MaybeAccessor<string>`	The `Id` of the query.
`cellId?`	`MaybeAccessor<undefined \| string>`	The `Id` of the result `Cell` whose values are used for the sorting, or `undefined` to sort by the result `Row` `Id` itself.
`descending?`	`MaybeAccessor<undefined \| boolean>`	Whether the sorting should be in descending order.
`offset?`	`MaybeAccessor<undefined \| number>`	The number of `Row` `Ids` to skip for pagination purposes, if any.
`limit?`	`MaybeAccessor<undefined \| number>`	The maximum number of `Row` `Ids` to return, or `undefined` for all.
`queriesOrQueriesId?`	`MaybeAccessor<undefined \| QueriesOrQueriesId>`	The `Queries` object to be accessed: omit for the default context `Queries` object, provide an `Id` for a named context `Queries` object, or provide an explicit reference.
returns	`Accessor<Ids>`	An array of the `Ids` of every `Row` in the result of the query.

A Provider component is used to wrap part of an application in a context, and it can contain a default Queries object or a set of Queries objects named by Id. The useResultSortedRowIds primitive lets you indicate which Queries object to get data for: omit the final optional parameter for the default context Queries object, provide an Id for a named context Queries object, or provide a Queries object explicitly by reference.

When first rendered, this primitive will create a listener so that changes to the sorted result Row Ids will cause an update. When the component containing this primitive is unmounted, the listener will be automatically removed.

Example

This example creates the TinyBase objects needed by the Solid primitive or component and calls it from within a reactive root.

import {createRoot} from 'solid-js';
import {
  createCheckpoints,
  createIndexes,
  createMetrics,
  createQueries,
  createRelationships,
  createStore,
} from 'tinybase';
import {useResultSortedRowIds} from 'tinybase/ui-solid';

createRoot((dispose) => {
  const store = createStore()
    .setTables({
      pets: {
        fido: {species: 'dog', color: 'brown', next: 'felix'},
        felix: {species: 'cat', color: 'black'},
      },
      species: {dog: {price: 5}, cat: {price: 4}},
    })
    .setValues({open: true});
  const metrics = createMetrics(store).setMetricDefinition(
    'highestPrice',
    'species',
    'max',
    'price',
  );
  const indexes = createIndexes(store).setIndexDefinition(
    'bySpecies',
    'pets',
    'species',
  );
  const relationships = createRelationships(store)
    .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    .setRelationshipDefinition('nextPet', 'pets', 'pets', 'next');
  const queries = createQueries(store).setQueryDefinition(
    'petColors',
    'pets',
    ({select, where, param}) => {
      select('color');
      where((getCell) => getCell('species') == param('species'));
    },
    {species: 'dog'},
  );
  const checkpoints = createCheckpoints(store);
  store.setCell('pets', 'fido', 'color', 'walnut');
  checkpoints.setCheckpoint('updated color');
  metrics.getMetric('highestPrice');
  indexes.getSliceIds('bySpecies');
  relationships.getRemoteRowId('petSpecies', 'fido');
  queries.getResultRowIds('petColors');
  useResultSortedRowIds(
    'petColors',
    'color',
    false,
    0,
    undefined,
    queries,
  );
  dispose();
});

Since

v8.3.0