`useCellIds`

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

useCellIds(
  tableId: MaybeAccessor<string>,
  rowId: MaybeAccessor<string>,
  storeOrStoreId?: MaybeAccessor<undefined | StoreOrStoreId>,
): Accessor<Ids>

	Type	Description
`tableId`	`MaybeAccessor<string>`	The `Id` of the `Table` in the `Store`.
`rowId`	`MaybeAccessor<string>`	The `Id` of the `Row` in the `Table`.
`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.
returns	`Accessor<Ids>`	An array of the `Ids` of every `Cell` in the `Row`.

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 useCellIds 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 Cell 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 {useCellIds} from 'tinybase/ui-solid';

createRoot((dispose) => {
  const store = createStore().setRow('pets', 'fido', {species: 'dog'});
  const cellIds = useCellIds('pets', 'fido', store);
  console.log(JSON.stringify(cellIds()));
  // -> '["species"]'
  dispose();
});

Since

v8.3.0