Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1006 Bytes

README.md

File metadata and controls

50 lines (35 loc) · 1006 Bytes

vuejs-countdown

A simple countdown timer component for VueJS 2.

screenshot

Installation

npm

npm i vuejs-countdown --save

Usage

<template>
  <div>
    <Countdown deadline="August 22, 2022"></Countdown>
    or 
    <Countdown end="August 22, 2022"></Countdown>
  </div>
</template>
<script>
import Countdown from 'vuejs-countdown'

export default {
  components: { Countdown }
}
</script>

Other Config

You can stop the countdown timer anytime by passing true (Boolean) with stop props.

You can decide whether to show the days when they are zero by passing true (Boolean) with showZeroDays props.

Example:

<div class="days-remaining">
    <Countdown :end="timerEnd" :showZeroDays="true"></Countdown>
</div>

Caution

Please don't provide any confusing date format since it has no dependency to Moment.js or any other date helpers.