TinyBase logoTinyBase β

useCellIdsListener

The useCellIdsListener hook registers a listener that is called whenever the Cell Ids in a Row change.

useCellIdsListener(
  tableId: MaybeGetter<IdOrNull>,
  rowId: MaybeGetter<IdOrNull>,
  listener: CellIdsListener,
  mutator?: boolean,
  storeOrStoreId?: MaybeGetter<undefined | StoreOrStoreId>,
): void
TypeDescription
tableIdMaybeGetter<IdOrNull>

The Id of the Table to listen to, or null to listen to any Table.

rowIdMaybeGetter<IdOrNull>

The Id of the Row to listen to, or null to listen to any Row.

listenerCellIdsListener

The function to call when Cell Ids change.

mutator?boolean

An optional boolean indicating the listener mutates Store data.

storeOrStoreId?MaybeGetter<undefined | StoreOrStoreId>

The Store to use, or its Id.

returnsvoid

This has no return value.

Since

v8.1.0