react-use/docs/useMediatedState.md

43 lines
1.0 KiB
Markdown

# `useMediatedState`
A lot like the standard `useState`, but with mediation process.
## Usage
```ts
import * as React from 'react';
import { useMediatedState } from '../useMediatedState';
const InputMediator = s => s.replace(/[\s]+/, ' ');
const Demo = () => {
const [state, setState] = useMediatedState('', InputMediator);
return (
<div>
<div>You will not be able to enter more than one space</div>
<input
type="number"
min="0"
max="10"
value={state}
onChange={(ev: React.ChangeEvent<HTMLInputElement>) => {
setState(ev.target.value);
}}
/>
</div>
);
};
```
## Reference
```ts
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._