Timekeeper Countdown

Countdown timer library for React and beyond

Get Started

API Reference

React Hook

useCountdown hook with full TypeScript support and automatic lifecycle management.

Core Engine

Framework-agnostic countdown engine for Node.js, vanilla JS, or any runtime.

Testing Utilities

Built-in fake clocks and snapshot factories for deterministic timer testing.

What ships today?

@timekeeper-countdown/react – exposes the useCountdown hook.
Shared helpers under @timekeeper-countdown/core/* – formatting utilities, fake clocks, and TypeScript types used by the hook.

What is coming next?

The core engine already powers the React package. Additional adapters are being stabilised so each framework gets a native experience with the same behaviour:

@timekeeper-countdown/angular
@timekeeper-countdown/vue
@timekeeper-countdown/svelte
Lightweight vanilla bindings for direct DOM use

Documentation Map

Getting Started – install the React package, understand snapshots, and render your first timer.
Core Usage – use the core engine directly in Node.js, vanilla JS, or any framework without a dedicated adapter.
API Reference – complete reference for useCountdown, its options, and the data it returns.
Advanced Usage – custom clocks, coordinating multiple timers, and formatting strategies.
Examples – copy-and-paste React snippets for common scenarios.
Roadmap & Future Adapters – overview of what is planned beyond React.
FAQ – answers to common questions.

Looking for the source? Everything lives in the packages/ directory. Contributions are welcome!