`useResultSortedRowIdsListener`

The useResultSortedRowIdsListener primitive registers a listener function with a Queries object that will be called whenever the sorted (and optionally, paginated) Row Ids in a ResultTable change.

useResultSortedRowIdsListener(
  queryId: MaybeAccessor<string>,
  cellId: MaybeAccessor<undefined | string>,
  descending: MaybeAccessor<boolean>,
  offset: MaybeAccessor<number>,
  limit: MaybeAccessor<undefined | number>,
  listener: ResultSortedRowIdsListener,
  queriesOrQueriesId?: MaybeAccessor<undefined | QueriesOrQueriesId>,
): void

	Type	Description
`queryId`	`MaybeAccessor<string>`	The `Id` of the query to listen to.
`cellId`	`MaybeAccessor<undefined \| string>`	The `Id` of the `Cell` whose values are used for the sorting, or `undefined` to sort by the `Row` `Id` itself.
`descending`	`MaybeAccessor<boolean>`	Whether the sorting should be in descending order.
`offset`	`MaybeAccessor<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.
`listener`	`ResultSortedRowIdsListener`	The function that will be called whenever the `Row` `Ids` in the matching `ResultTable` change.
`queriesOrQueriesId?`	`MaybeAccessor<undefined \| QueriesOrQueriesId>`	The `Queries` object to register the listener with: omit for the default context `Queries` object, provide an `Id` for a named context `Queries` object, or provide an explicit reference.
returns	`void`	This has no return value.

This primitive is useful for situations where a component needs to register its own specific listener to do more than simply tracking the value (which is more easily done with the useResultSortedRowIds primitive).

Unlike the addResultSortedRowIdsListener method, which returns a listener Id and requires you to remove it manually, the useResultSortedRowIdsListener primitive manages this lifecycle for you: when the listener changes (per its you to remove it manually, the useResultSortedRowIdsListener primitive manages this lifecycle for you: when the component unmounts, the listener on the underlying Queries object will be deleted.

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 {useResultSortedRowIdsListener} 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');
  useResultSortedRowIdsListener(
    'petColors',
    'color',
    false,
    0,
    undefined,
    () => undefined,
    queries,
  );
  dispose();
});

Since

v8.3.0