`useSetRowCallback`

The useSetRowCallback hook returns a parameterized callback that can be used to set the data of a single Row in a Store.

useSetRowCallback<Parameter>(
  tableId: string | GetId<Parameter>,
  rowId: string | GetId<Parameter>,
  getRow: (parameter: Parameter, store: Store) => Row,
  getRowDeps?: DependencyList,
  storeOrStoreId?: StoreOrStoreId,
  then?: (store: Store, row: Row) => void,
  thenDeps?: DependencyList,
): ParameterizedCallback<Parameter>

	Type	Description
`tableId`	`string \| GetId<Parameter>`	The `Id` of the `Table` in the `Store`, or a `GetId` function that will return it.
`rowId`	`string \| GetId<Parameter>`	The `Id` of the `Row` in the `Table` to set, or a `GetId` function that will return it.
`getRow`	`(parameter: Parameter, store: Store) => Row`	A function which returns the `Row` object that will be used to update the `Store`, based on the parameter the callback will receive (and which is most likely a DOM event).
`getRowDeps?`	`DependencyList`	An optional array of dependencies for the `getRow` function, which, if any change, result in the regeneration of the callback. This parameter defaults to an empty array. Also use this to indicate the dependencies of any `GetId` functions if used as the tableId or rowId arguments.
`storeOrStoreId?`	`StoreOrStoreId`	The `Store` to be updated: omit for the default context `Store`, provide an `Id` for a named context `Store`, or provide an explicit reference.
`then?`	`(store: Store, row: Row) => void`	A function which is called after the mutation, with a reference to the `Store` and the `Row` used in the update.
`thenDeps?`	`DependencyList`	An optional array of dependencies for the `then` function, which, if any change, result in the regeneration of the callback. This parameter defaults to an empty array.
returns	`ParameterizedCallback<Parameter>`	A parameterized callback for subsequent use.

This hook is useful, for example, when creating an event handler that will mutate the data in the Store. In this case, the parameter will likely be the event, so that you can use data from it as part of the mutation.

The third parameter is a function which will produce the Row object that will then be used to update the Store in the callback.

If that function has any other dependencies, the changing of which should also cause the callback to be recreated, you can provide them in an array in the optional fourth parameter, just as you would for any React hook with dependencies.

For convenience, you can optionally provide a then function (with its own set of dependencies) which will be called just after the Store has been updated. This is a useful place to call the addCheckpoint method, for example, if you wish to add the mutation to your application's undo stack.

The Store to which the callback will make the mutation (indicated by the hook's storeOrStoreId parameter) is always automatically used as a hook dependency for the callback.

Example

This example uses the useSetRowCallback hook to create an event handler which updates the Store when the span element is clicked.

import {useRow, useSetRowCallback} from 'tinybase/ui-react';
import React from 'react';
import {createRoot} from 'react-dom/client';
import {createStore} from 'tinybase';

const store = createStore().setRow('pets', 'nemo', {species: 'fish'});
const App = () => {
  const handleClick = useSetRowCallback(
    'pets',
    'nemo',
    (e) => ({species: 'fish', bubbles: e.bubbles}),
    [],
    store,
    (store, row) => console.log(`Updated: ${JSON.stringify(row)}`),
  );
  return (
    <span id="span" onClick={handleClick}>
      {JSON.stringify(useRow('pets', 'nemo', store))}
    </span>
  );
};

const app = document.createElement('div');
createRoot(app).render(<App />);
const span = app.querySelector('span');
console.log(span.innerHTML);
// -> '{"species":"fish"}'

// User clicks the <span> element:
// -> span MouseEvent('click', {bubbles: true})
// -> 'Updated: {"species":"fish","bubbles":true}'

console.log(span.innerHTML);
// -> '{"species":"fish","bubbles":true}'

Since

v1.0.0