`useLocalRowIds`

The useLocalRowIds primitive gets the local Row Ids for a given remote Row in a Relationship, and registers a listener so that any changes to that result will cause an update.

useLocalRowIds(
  relationshipId: MaybeAccessor<string>,
  remoteRowId: MaybeAccessor<string>,
  relationshipsOrRelationshipsId?: MaybeAccessor<undefined | RelationshipsOrRelationshipsId>,
): Accessor<Ids>

	Type	Description
`relationshipId`	`MaybeAccessor<string>`	The `Id` of the `Relationship`.
`remoteRowId`	`MaybeAccessor<string>`	The `Id` of the remote `Row` in the `Relationship`.
`relationshipsOrRelationshipsId?`	`MaybeAccessor<undefined \| RelationshipsOrRelationshipsId>`	The `Relationships` object to be accessed: omit for the default context `Relationships` object, provide an `Id` for a named context `Relationships` object, or provide an explicit reference.
returns	`Accessor<Ids>`	The local `Row` `Ids` in the `Relationship`, or an empty array.

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

When first rendered, this primitive will create a listener so that changes to the local Row Id 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 {useLocalRowIds} 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');
  useLocalRowIds('petSpecies', 'dog', relationships);
  dispose();
});

Since

v8.3.0