useSetValuesCallback

The useSetValuesCallback hook returns a parameterized callback that can be used to set the keyed value data of a Store.

useSetValuesCallback<Parameter>(
  getValues: (parameter: Parameter, store: Store) => Values,
  getValuesDeps?: DependencyList,
  storeOrStoreId?: any,
  then?: (store: Store, values: Values) => void,
  thenDeps?: DependencyList,
): ParameterizedCallback<Parameter>

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 first parameter is a function which will produce the Values 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 second 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.

const store = createStore().setValues({open: true});
const App = () => {
  const handleClick = useSetValuesCallback(
    (e) => ({bubbles: e.bubbles}),
    [],
    store,
    (store, values) => console.log(`Updated: ${JSON.stringify(values)}`),
  );
  return (
    <span id="span" onClick={handleClick}>
      {JSON.stringify(useValues(store))}
    </span>
  );
};

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

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

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