https://github.com/fengyuanchen/vue-countdown

Countdown component for Vue.js.
https://github.com/fengyuanchen/vue-countdown

countdown vue vue-component

Last synced: 26 days ago
JSON representation

Countdown component for Vue.js.

• Host: GitHub
• URL: https://github.com/fengyuanchen/vue-countdown
• Owner: fengyuanchen
• License: mit
• Created: 2017-04-10T10:36:41.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-08-26T09:13:08.000Z (about 1 year ago)
• Last Synced: 2024-05-22T20:04:12.017Z (6 months ago)
• Topics: countdown, vue, vue-component
• Language: TypeScript
• Homepage: https://fengyuanchen.github.io/vue-countdown/
• Size: 1.37 MB
• Stars: 665
• Watchers: 7
• Forks: 89
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-countdown

[![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/vue-countdown.svg)](https://codecov.io/gh/fengyuanchen/vue-countdown) [![Downloads](https://img.shields.io/npm/dm/@chenfengyuan/vue-countdown.svg)](https://www.npmjs.com/package/@chenfengyuan/vue-countdown) [![Version](https://img.shields.io/npm/v/@chenfengyuan/vue-countdown.svg)](https://www.npmjs.com/package/@chenfengyuan/vue-countdown) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/@chenfengyuan/vue-countdown.svg)](https://unpkg.com/@chenfengyuan/vue-countdown/dist/vue-countdown.js)

> Countdown component for Vue 3. For Vue 2, check out the [`v1`](https://github.com/fengyuanchen/vue-countdown/tree/v1) branch.

- [Docs](src/README.md)

- [Demo](https://fengyuanchen.github.io/vue-countdown)

## Main npm package files

```text

dist/

├── vue-countdown.js         (UMD, default)

├── vue-countdown.min.js     (UMD, compressed)

├── vue-countdown.esm.js     (ECMAScript Module)

├── vue-countdown.esm.min.js (ECMAScript Module, compressed)

└── vue-countdown.d.ts       (TypeScript Declaration File)

```

## Getting started

### Installation

Using npm:

```shell

npm install vue@3 @chenfengyuan/vue-countdown@2

```

Using pnpm:

```shell

pnpm add vue@3 @chenfengyuan/vue-countdown@2

```

Using Yarn:

```shell

yarn add vue@3 @chenfengyuan/vue-countdown@2

```

Using CDN:

```html

```

### Usage

```js

import { createApp } from 'vue';

import VueCountdown from '@chenfengyuan/vue-countdown';

const app = createApp({});

app.component(VueCountdown.name, VueCountdown);

```

```html

  Time Remaining：{{ days }} days, {{ hours }} hours, {{ minutes }} minutes, {{ seconds }} seconds.

```

## Browser support

Same as Vue 3.

## Versioning

Maintained under the [Semantic Versioning guidelines](https://semver.org/).

## License

[MIT](https://opensource.org/licenses/MIT) © [Chen Fengyuan](https://chenfengyuan.com/)