https://github.com/sevenoutman/use-increment

React Hook for incrementing value
https://github.com/sevenoutman/use-increment

react react-hooks react-state

Last synced: about 2 months ago
JSON representation

React Hook for incrementing value

• Host: GitHub
• URL: https://github.com/sevenoutman/use-increment
• Owner: SevenOutman
• License: mit
• Created: 2019-11-05T11:14:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-06T04:38:08.000Z (over 5 years ago)
• Last Synced: 2025-02-14T03:01:52.544Z (2 months ago)
• Topics: react, react-hooks, react-state
• Language: TypeScript
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# use-increment

> React Hook for incrementing value

    yarn add @sevenoutman/use-increment

## Usage

```javascript

import useIncrement from '@sevenoutman/use-increment';

function App() {

    

    const [clickCount, increment] = useIncrement(0);

    

    return (

        

            You've clicked {clickCount} times.

        

    );

}

```

## API

### `useIncrement(initialValue?: number, step?: number): [value, increment]`

Default hook signature, returns a array representing `[value, increment]`.

- `initialValue`: Initial value for `value`, defaults to 1.

- `step`: Increment step, defaults to 1.

### `increment(): void`

Increment `value` by `step`.

### `increment.by(amount: number): void`

When you want to increment your value by a different amount from `step`, use `increment.by(amount)`.