react-code-dataset / react-use /docs /useMediatedState.md
Devendra174's picture
Upload folder using huggingface_hub
1e92f2d verified

useMediatedState

A lot like the standard useState, but with mediation process.

Usage

import * as React from 'react';
import { useMediatedState } from '../useMediatedState';

const inputMediator = s => s.replace(/[\s]+/g, ' ');
const Demo = () => {
  const [state, setState] = useMediatedState(inputMediator, '');

  return (
    <div>
      <div>You will not be able to enter more than one space</div>
      <input type="text" min="0" max="10" 
             value={state}
             onChange={(ev: React.ChangeEvent<HTMLInputElement>) => {
               setState(ev.target.value);
             }}
      />
    </div>
  );
};

Reference

const [state, setState] = useMediatedState<S=any>(
  mediator: StateMediator<S>,
  initialState?: S
);

Initial state will be set as-is.

In case mediator expects 2 arguments it will receive the setState function as second argument, it is useful for async mediators.

This hook will not cancel previous mediation when new one been invoked, you have to handle it yourself._