npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gabrielyotoo/react-use-timer

v2.3.0

Published

Hook for timer to React

Downloads

33

Readme

@gabrielyotoo/react-use-timer · GitHub licensenpm version

react-use-timer is a hook to help you with timers in React.

Example

Installation

To install run the following command in your project's folder if you are using yarn

yarn add @gabrielyotoo/react-use-timer

or if you are using npm

npm install @gabrielyotoo/react-use-timer

Usage

A simple timer example showing the current time from 10 to 0.

import { useTimer } from '@gabrielyotoo/react-use-timer';

function App() {
  const [finished, setFinished] = useState(false);

  const { currentTime, isRunning, start, pause } = useTimer(10, {
    onFinish: () => {
      setFinished(true);
    },
    onStart: () => {
      setFinished(false);
    },
  });

  return (
    <>
      {finished ? <p>Finished!</p> : null}
      <div>
        {!isRunning ? (
          <p>Not running! Timer at {currentTime}</p>
        ) : (
          <p>Timer at {currentTime}</p>
        )}
        <button onClick={start}>{!isRunning ? 'Start!' : 'Reset'}</button>
        {isRunning ? <button onClick={pause}>Pause</button> : null}
      </div>
    </>
  );
}

You can also run the example project.

API

| Name | Type | Description | | -------------------------------------------------------------------------------------------------------- | -------- | -------------------------------- | | useTimer(time: number, options?: UseTimerOptions): UseTimerReturn | function | Create timer with specified time |

useTimer Params

| Name | Type | Optional | Description | | ------- | ----------------------------------- | -------- | ------------------------------- | | time | number | false | The amount of ticks to run | | options | UseTimerOptions | true | The configuration for the timer |

UseTimerReturn

| Name | Type | Description | | ------------- | -------- | ------------------------------- | | currentTime | number | The current time of the timer | | start(): void | function | The function to start the timer | | isRunning | boolean | If the timer is running or not | | pause(): void | function | The function to pause the timer |

UseTimerOptions

| Name | Type | Optional | Description | | ---------------- | -------- | -------- | ----------------------------------------------- | | autoStart | boolean | true | If the timer should start in the first render | | interval | number | true | The interval in milliseconds between ticks | | onStart(): void | function | true | The function to be called when the timer starts | | onFinish(): void | function | true | The function to be called after the time's up |

Contributing

Please, feel free to create issues and to open PRs. Be cautious to the tests and builds, because if your version doesn't pass they, your PR won't be approved and merged