# @whitewizard/countdown

> Universal countdown Vue component

Latest version **1.1.2** (published 2025-12-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install @whitewizard/countdown
pnpm add @whitewizard/countdown
yarn add @whitewizard/countdown
bun add @whitewizard/countdown
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2025-12-23 |
| First published | 2017-11-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mikk Narusk |
| Maintainers | whitewizard |

## Links

- npm: https://www.npmjs.com/package/@whitewizard/countdown
- npm.io page: https://npm.io/package/@whitewizard/countdown

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.19.1

## Recent versions

- 1.1.2 (latest) — 2025-12-23
- 1.1.0 — 2025-12-23
- 1.0.6 — 2022-01-27
- 1.0.5 — 2019-03-01
- 1.0.4 — 2019-01-25
- 1.0.3 — 2017-11-21
- 1.0.2 — 2017-11-21
- 1.0.1 — 2017-11-13

## README

## Countdown Vue component

### Usage:
* `import Countdown from @whitewizard/countdown`
* Implements an unnamed slot to display something inside component.
    * Slot usage: [Vue.js slots](https://vuejs.org/v2/guide/components.html#Single-Slot)
* Root element gets 'countdown-ended' class when countdown end is reached.
* Emits 'countDownEnd' event with root HTML element as `event.el`
    * Event usage: `<Countdown @countDownEnd="myHandler" />`

### Props:
* format {String}. String representing units to display, separated by colons. Default: `hours:minutes:seconds`
* separators {String}. Text to show between countdown data elements, separated by colons. Default: `h:m:s`
* end {String} RFC 3339 datetime string. Represents countdown end time. Required. ([RFC 3339](https://tools.ietf.org/html/rfc3339))

---
_Source: https://npm.io/package/@whitewizard/countdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._