Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 1.43 KB

README.md

File metadata and controls

63 lines (47 loc) · 1.43 KB
Raw

@vuecs/countdown ⏰

npm version CI

This package provides a customizable countdown timer for Vue3 web applications. It offers a range of options for customization, including start and end times, step length, and more. Ideal for time-based events such as auctions, sales, or promotions.

Table of Contents

Installation

$ npm i --save @vuecs/countdown

Usage

Register the plugin.

import install from '@vuecs/countdown';
import { createApp } from 'vue'

const app = createApp({})

app.use(install, {
  /* optional options */
})

After the component is registered, it can be used as follows.

<template>
    <VCCountdown
        :auto-start="true"
        :emit-events="true"
        :interval="1000"
        :time="3600 * 1000"
    >
        <template #default="props">
            The countdown is still running for
            <span>
                {{ props.hours }} hour(s),
                {{ props.minutes }} minute(s),
                {{ props.seconds }} second(s)
            </span>.
        </template>
    </VCCountdown>
</template>

License

Made with 💚

Published under MIT License.