Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.26 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.26 KB
Raw

react-countdonw-timer-component

This is a react UI component of displaying countdown timer

demo

demo

You can find deployed demo version here: https://maomaozh.github.io/countdown-timer/

Installation

yarn add react-countdown-timer-component

or

npm install react-countdown-timer-component

How to use it

import React from "react";
import { render } from "react-dom";
import CountdownTimer from "react-countdown-timer-component";

render(
  <CountdownTimer
    seconds={80}
    isDisplayEndTime={false}
    isDisplayResetButton={true}
  />,
  document.getElementById("root")
);

Props

seconds: number

overall countdown seconds. This props is required.

isDisplayEndTime: bool

this will display a string with endtime, eg "Be back at ${endtime}". This props is optional, default setting is false.

isDisplayResetButton: bool

this will display a button to reset timer to "00:00:00". This props is optional, default setting is false.

timerWrapperClass: string

You can define your timer wrapper class. This props is optional.

timerClass: string

You can define your timer class. This props is optional.

License

MIT