TinyBase logoTinyBase β

useRowIds

The useRowIds primitive returns the Ids of every Row in a given Table, and registers a listener so that any changes to that result will cause an update.

useRowIds(
  tableId: MaybeAccessor<string>,
  storeOrStoreId?: MaybeAccessor<undefined | StoreOrStoreId>,
): Accessor<Ids>
TypeDescription
tableIdMaybeAccessor<string>

The Id of the Table in the Store.

storeOrStoreId?MaybeAccessor<undefined | StoreOrStoreId>

The Store to be accessed: omit for the default context Store, provide an Id for a named context Store, or provide an explicit reference.

returnsAccessor<Ids>

An array of the Ids of every Row in the Table.

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

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

Example

This example creates a Store, binds it to the primitive, and reads the resulting Solid Accessor.

import {createRoot} from 'solid-js';
import {createStore} from 'tinybase';
import {useRowIds} from 'tinybase/ui-solid';

createRoot((dispose) => {
  const store = createStore().setTable('pets', {
    fido: {species: 'dog'},
    felix: {species: 'cat'},
  });
  const rowIds = useRowIds('pets', store);
  console.log(JSON.stringify(rowIds()));
  // -> '["fido","felix"]'
  dispose();
});

Since

v8.3.0