docs: ✏️ update useCounter docs

This commit is contained in:
streamich 2018-10-29 18:46:51 +01:00
parent a58a4a7889
commit 4e362ac8f7
2 changed files with 9 additions and 4 deletions

View File

@ -79,7 +79,7 @@
- [`useObservable`](./docs/useObservable.md) — tracks latest value of an `Observable`.
- [`useSetState`](./docs/useSetState.md) — creates `setState` method which works like `this.setState`. [![][img-demo]](https://codesandbox.io/s/n75zqn1xp0)
- [`useToggle` and `useBoolean`](./docs/useToggle.md) — tracks state of a boolean.
- [`useCounter` as `useNumber`](./docs/useCounter.md) — tracks state of a number.
- [`useCounter` and `useNumber`](./docs/useCounter.md) — tracks state of a number.
- [`useList`](./docs/useList.md) — tracks state of an array.
- [`useMap`](./docs/useMap.md) — tracks state of an object.
<br/>

View File

@ -8,16 +8,21 @@ React state hook that tracks a numeric value.
## Usage
```jsx
import {useCounter} from 'react-use';
import {useCounter, useNumber} from 'react-use';
const Demo = () => {
const [value, inc, set] = useCounter();
const [value, {inc, dec, get, set, reset}] = useCounter(5);
return (
<div>
<div>{value}</div>
<div>{value} is {get()}</div>
<button onClick={() => inc()}>Increment</button>
<button onClick={() => dec()}>Decrement</button>
<button onClick={() => inc(5)}>Increment (+5)</button>
<button onClick={() => dec(5)}>Decrement (-5)</button>
<button onClick={() => set(100)}>Set 100</button>
<button onClick={() => reset()}>Reset</button>
<button onClick={() => reset(25)}>Reset (25)</button>
</div>
);
};