TinyBase logoTinyBase β

useCellListener

The useCellListener hook registers a listener that is called whenever the value of a specified Cell changes.

useCellListener(
  tableId: MaybeGetter<IdOrNull>,
  rowId: MaybeGetter<IdOrNull>,
  cellId: MaybeGetter<IdOrNull>,
  listener: CellListener,
  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.

cellIdMaybeGetter<IdOrNull>

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

listenerCellListener

The function to call when the Cell changes.

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