`useLinkedRowIdsListener`

The useLinkedRowIdsListener primitive registers a listener function with the Relationships object that will be called whenever the linked Row Ids in a Relationship change.

useLinkedRowIdsListener(
  relationshipId: MaybeAccessor<string>,
  firstRowId: MaybeAccessor<string>,
  listener: LinkedRowIdsListener,
  relationshipsOrRelationshipsId?: MaybeAccessor<undefined | RelationshipsOrRelationshipsId>,
): void

	Type	Description
`relationshipId`	`MaybeAccessor<string>`	The `Id` of the `Relationship` to listen to.
`firstRowId`	`MaybeAccessor<string>`	The `Id` of the first `Row` of the linked list to listen to.
`listener`	`LinkedRowIdsListener`	The function that will be called whenever the linked `Row` `Ids` change.
`relationshipsOrRelationshipsId?`	`MaybeAccessor<undefined \| RelationshipsOrRelationshipsId>`	The `Relationships` object to register the listener with: omit for the default context `Relationships` object, provide an `Id` for a named context `Relationships` 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 useLinkedRowIds primitive).

Unlike other listener registration methods, you cannot provide null wildcards for the first two parameters of the useLinkedRowIdsListener method. This prevents the prohibitive expense of tracking all the possible linked lists (and partial linked lists within them) in a Store.

Unlike the addLinkedRowsIdListener method, which returns a listener Id and requires you to remove it manually, the useLinkedRowIdsListener primitive manages this lifecycle for you: when the component unmounts, the listener on the underlying Indexes 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 {useLinkedRowIdsListener} 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');
  useLinkedRowIdsListener(
    'nextPet',
    'fido',
    () => undefined,
    relationships,
  );
  dispose();
});

Since

v8.3.0