@rooks/use-counter
TypeScript icon, indicating that this package has built-in type declarations

4.11.2 • Public • Published

@rooks/use-counter

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

Build Status

About

Counter hook for React.

Installation

npm install --save @rooks/use-counter

Importing the hook

import useCounter from "@rooks/use-counter"

Usage

function CounterComponent() {
  const {
    value,
    increment,
    decrement,
    incrementBy,
    decrementBy,
    reset
  } = useCounter(3);


  function incrementBy5(){
     incrementBy(5)
  }
  function decrementBy7(){
     decrementBy(7)
  }

  return <>
      Current value is {value}
      <hr/>
      <button onClick={increment}>increment</button>
      <button onClick={decrement}>decrement</button>
      <button onClick={incrementBy5} >incrementBy5</button>
      <button onClick={decrementBy7} >decrementBy7</button>
      <hr/>
      <button onClick={reset}>reset</button>
  </>;
}

render(<CounterComponent/>)

Arguments

Argument Type Description
initialValue number Initial value of the counter

Return

Return value Type Description
counter Object Object containing {value,increment,decrement,incrementBy,decrementBy,reset}

Package Sidebar

Install

npm i @rooks/use-counter

Weekly Downloads

8

Version

4.11.2

License

MIT

Unpacked Size

148 kB

Total Files

15

Last publish

Collaborators

  • imbhargav5