1.0.1 • Published 4 years ago

countdown-react-component v1.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

countdown-react

Simple, light adn reusable component for countdown timer in react

NPM JavaScript Style Guide

Install

npm install --save countdown-react

Usage

import React from 'react'

import CountDown from "countdown-react-component";

const Example = () => {
  const [run, setRun] = useState(false)
    return (
      <div>
        <button onClick={e => setRun(true)}>Start</button>
        <CountDown s={35} run={run} setRun={setRun}/>
      </div>
    )
}

Check out usage examples in playground

Documentation

parameters

  • s {number} seconds that countdown is going to run
  • m {number} minutes that countdown is going to run
  • h {number} hours that countdown is going to run
  • run {boolean} set this to true whenever you want the countdown to start
  • setRun {function} with this props you can pause or resume the countdown

full example

import React, {useState} from 'react'
import CountDown from "countdown-react-component";

const App = () => {
  const [run, setRun] = useState(false)
  const [seconds, setSeconds] = useState(0)
  const [minutes, setMinutes] = useState(0)
  const [hours, setHours] = useState(0)
  return (
    <div>
      Seconds:<input value={seconds} onChange={e => setSeconds(e.target.value)}/>
      Minutes:<input value={minutes} onChange={e => setMinutes(e.target.value)}/>
      Hours:<input value={hours} onChange={e => setHours(e.target.value)}/>

      <button onClick={e => setRun(true)}>Start</button>
      <button onClick={e => setRun(false)}>Pause</button>
      <CountDown  s={5} m={minutes} h={hours} run={run} setRun={setRun} />
    </div>
    )
}

export default App

License

MIT © TahaJm