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 🙏

© 2022 – Pkg Stats / Ryan Hefner

react-timer-wrapper

v0.4.1

Published

Composable React Timer component that passes its status to its children.

Downloads

2,142

Readme

⏳ react-timer-wrapper

npm NPM npm Coveralls github CircleCI Snyk Vulnerabilities for GitHub Repo

Composable React Timer component that passes status props to children, in addition to some basic callbacks. Can be used at a countdown timer ⏲ or as stopwatch ⏱ to track time while active.

Install

Via npm

npm install --save react-timer-wrapper

Via Yarn

yarn add react-timer-wrapper

How to use

The Timer can be used in a couple different ways. You could use it as a standalone timer and setup callbacks to trigger things to happen in your project. Or, wrap child components in Timer component, where those children will receive props passed in by the Timer.

It can be used as a countdown timer, which will fire the onFinish event upon completion. Or, you can use it to track the time that occurs while it’s active.

Properties

  • active:Boolean - Start/stop the timer. (Default: false)
  • component:String | Element - Element or React component used to render/wrap the children. (Default: div)
  • duration:Number - Enables countdown mode and is the number of milliseconds to count before firing onFinish. (Default: 10000)
  • loop:Boolean - Enable looping of the countdown timer. (Default: false)
  • time:Number - Either used as a time offset for the duration when used as a countdown timer, or the initial time to start from when used for tracking time. (Default: 0)
  • onFinish:Function - Callback fired when the timer has finished. (Fired in countdown mode only)
  • onStart:Function - Callback fired when the timer is started.
  • onStop:Function - Callback fired when the timer is stopped.
  • onTimeUpdate:Function - Callback fired when time updates.

Examples

Standalone

import Timer from 'react-timer-wrapper';

...

  onTimerStart({duration, progress, time}) {

  }

  onTimerStop({duration, progress, time}) {

  }

  onTimerTimeUpdate({duration, progress, time}) {

  }

  onTimerFinish({duration, progress, time}) {

  }

  render() {
    const {
      timerActive,
    } = this.state;

    return (
      <Timer
        active={timerActive}
        onFinish={this.onTimerFinish}
        onStart={this.onTimerStart}
        onStop={this.onTimerStop}
        onTimeUpdate={this.onTimerTimeUpdate}
      />
    );
  }

...

With children

import Timer from 'react-timer-wrapper';
import CircleIndicator from 'react-indicators';

...

  render() {
    const {
      timerShouldRun,
    } = this.state;

    return (
      <Timer active={timerShouldRun}>
        <CircleIndicator />
      </Timer>
    );
  }

...

Children

The Timer allows you to easily compose components that provide a visual status of the timer. Each children receives the following props that you can use to communicate the status of the timer.

  • duration:Number - Duration of the countdown timer. (Available for countdown timers only, null passed when used for time tracking)
  • progress:Number - Current percentage of timer complete. (Available for countdown timers only, null passed when used for time tracking)
  • time:Number - Current time on the timer in milliseconds.

Pairs well with...

License

MIT © Ryan Hefner