1.0.5 • Published 10 months ago

react-count-until v1.0.5

Weekly downloads
-
License
ISC
Repository
-
Last release
10 months ago

React Count Until

Count down until the given time

Installation

Install react-countdown-until with npm

  npm install react-countdown-until

Usage/Examples

import CountDown from "react-countdown-until";

function App() {
  return (
    <>
      {/* returns in format yyy:MM:dd:HH:mm:ss */}
      <CountUntil />
      {/* or */}
      <CountUntil date={new Date("2025-01-01")} />
    </>
  );
}

API Reference

ParameterTypeDescriptionDefault
dateDateOptional. A future Date objectnull
classNamestringOptional. Class names for root div'flex font-mono'
requireLabelsbooleanOptional. Display locales as labelsfalse
seperatorstringOptional. Seperator between timer parts':'
displayYearsbooleanOptional. To display years parttrue
displayMonthsbooleanOptional. To display months parttrue
displaydaysbooleanOptional. To display days parttrue
displayHoursbooleanOptional. To display hours parttrue
displayMinutesbooleanOptional. To display minutes parttrue
displaySecondsbooleanOptional. To display seconds parttrue

Authors

1.0.5

10 months ago

1.0.4

10 months ago

1.0.3

10 months ago

1.0.2

10 months ago

1.0.1

10 months ago

1.0.0

10 months ago