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

circle-timer

v0.1.6

Published

A module that creates circular / radial timers and clocks

Downloads

6

Readme

circleTimer

A JS class for making circular / radial timers and clocks

Installation

Use npm to add the module to your project:

npm install -S circle-timer

Usage

Import it into your code:

import CircleTimer from 'circle-timer';

Instantiate the timer object. Use the new keyword and pass it a single configuration argument:

this.circleTimer = new CircleTimer({
  rootElement: document.getElementById('my-circle-timer')
})

Possible settings and their defaults:

rootElement
The DOM element that the circle will be attached to. Defaults to the body tag.

circleDuration
The number of seconds that the entire circle represents. Defaults to 60.

timerDuration
The number of seconds that will be counted down. Defaults to 60.

timerClass
An additional class (or classes) that will be added to the circle timer element.

radius
The radius of the circle. Defaults to 200.

units
The units used for radius and thickness. Defaults to 'px'.

color
The foreground color of the circle's ring. Defaults to 'lightskyblue'.

backgroundRingColor
The background color of the circle's ring. The color that's visible as the time slips away. Defaults to 'gainsboro' (a light gray).

backgroundRingShadow
The inner shadow of the circle's ring. Defaults to 'inset 0 0 5px rgba(0, 0, 0, 0.1)'.

thickness
The thickness of the circle's ring. Defaults to 25.

style
The style of the circle's ring. Accepts a valid border-style value. Values other than solid may result in odd visuals. Defaults to 'solid'.

Methods

startTimer
Takes no arguments. Starts the clock.

pauseTimer
Takes no arguments. Pauses the clock.

resetTimer
Takes no arguments. Resets the timer to its initial duration.

updateTimer
Takes a configuration object as its only argument. Allows you to change circleDuration and timerDuration. Resets the timer.

Usage in React

The simplest way to use this with react is inside of componentDidMount. For example:

componentDidMount(){
  var element = document.getElementById('circle-timer');
  this.circleTimer = new CircleTimer({
    rootElement: element,
    color: 'red',
    backgroundRingColor: 'gray',
  })
}