Nuxt Countdown

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

A countdown module for multi purpose usage written for Nuxt 3 and 4.

Features

- Nuxt 3 and 4 Support
- Autoimport
- Less config

Documentation

While we're preparing detailed documentation and playground, you can check the examples below.

Quick Setup

1. Add nuxt-countdown dependency to your project

``bash


Using yarn

yarn add nuxt-countdown

Using npm

npm install nuxt-countdown

Using pnpm

pnpm add nuxt-countdown
`

2. Add nuxt-countdown to the modules section of nuxt.config.ts

`js
export default defineNuxtConfig({
modules: [
'nuxt-countdown'
]
})
`

That's it! You can now use Countdown Component in your Nuxt app ✨

Examples

When you add this module, the `` component will be automatically imported into the project.

$3

With `:date` prop, you can set the target date for countdown.

Then you can use slot props to show the countdown values in `days`, `hours`, `minutes`, `seconds` or `milliseconds`. (`milliseconds` is available for custom interval)

`js

`

$3

With `:time` prop, you can set the target time in milliseconds for countdown.

`js

`

$3

You can set custom interval time value for update countdown values with `:interval` prop, value in milliseconds.

`js