{"repo":"ndresx/react-countdown","free":true,"listed":false,"github":"https://github.com/ndresx/react-countdown","clone":"git clone https://github.com/ndresx/react-countdown.git","description":"A customizable countdown component for React.","language":"TypeScript","stars":788,"topics":["react","typescript","countdown","component","hacktoberfest"],"license":"MIT","category":"ui-components","readme_excerpt":"React <Countdown /> [![npm][npm]][npm-url] A customizable countdown component and Hook for React. - Getting Started - Motivation - Examples - Props - Hook - Lifecycle Callbacks - API Reference - Helpers - FAQ - Changelog - Contributing - License Getting Started v3 is in beta. Install it with npm install react-countdown@next . The current stable release is documented at the v2.3.6 tag. See the Changelog for what changed and how to migrate. You can install the module via npm , pnpm , or yarn : Imports The package ships as both ES modules and CommonJS, is fully typed, and is side-effect free, so bundlers can tree-shake it. Import the component and the useCountdown Hook from the package root: If you only need one of them, dedicated entry points let your bundler include just that part (plus the shared core) and leave the rest out: Motivation This countdown started as part of a small web app. Extracting it into its own package was a way to explore the broader aspects of building with React, testing with Jest, and publishing an open source project. Examples Here are some examples which you can try directly online. You can also clone this repo and explore some more examples in there by running pnpm start within the examples folder. Basic Usage A very simple and minimal example of how to set up a countdown that counts down from 10 seconds. Live Demo Custom & Conditional Rendering In case you want to change the output of the component, or want to signal that the countdown's work ","default_branch":null,"files":null,"tree":[],"storefront":"/r/ndresx","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ndresx/react-countdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}