# vue-countdownify

> 設定した日時までカウントダウンするコンポーネントです。

Latest version **0.1.9** (published 2021-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-countdownify
pnpm add vue-countdownify
yarn add vue-countdownify
bun add vue-countdownify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.9 |
| Published | 2021-03-27 |
| First published | 2021-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 2.4 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | kobatakuJP |
| Maintainers | kobataku |
| Keywords | Vue, Vue.js, countdown, time |

## Links

- npm: https://www.npmjs.com/package/vue-countdownify
- npm.io page: https://npm.io/package/vue-countdownify

## Dependencies (4)

- [vue](https://npm.io/package/vue.md) ^2.6.11
- [dseg](https://npm.io/package/dseg.md) ^0.46.0
- [dayjs](https://npm.io/package/dayjs.md) ^1.10.4
- [core-js](https://npm.io/package/core-js.md) ^3.6.5

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 0.1.9 (latest) — 2021-03-27
- 0.1.8 — 2021-03-21
- 0.1.7 — 2021-03-21
- 0.1.6 — 2021-03-06
- 0.1.4 — 2021-02-23
- 0.1.3 — 2021-02-23
- 0.1.2 — 2021-02-23
- 0.1.1 — 2021-02-23
- 0.1.0 — 2021-02-23

## README

# vue-countdownify

設定した日時までカウントダウンするコンポーネントです。

![countdownify-demo](https://user-images.githubusercontent.com/36495393/108831666-c8c5f100-760d-11eb-8719-08a592149abf.gif)

## Install

### npm

```
$ npm install --save vue-countdownify
```

### import at javascript

```
import Countdownify from 'vue-countdownify';
import 'vue-countdownify/dist/vue-countdownify.css'
```

## Usage

### Props

|Name|Type|Required|Default|Description|
|:--|:--|:--|:--|:--|
|msg|String|false|"終了"|ヘッダに表示される文字列。「{{msg}}まで」と表示される。|
|goal-time|String|true|-|カウントダウンする先の時刻。[dayjs](https://day.js.org/en/)のコンストラクタに引数として渡すことができる形式で入力。<br>例：<br>`goal-time="2021-04-04T16:00:00.000Z"`<br>`:goal-time="[2021, 5, 4]`|
|backgroundColor|String|false|"black"|背景色。[color書式](https://developer.mozilla.org/ja/docs/Web/CSS/color_value)に則ります。<br>例：`:background-color="red"`|

### Event

|Name|Description|
|:--|:--|
|its-time|設定時刻になるとイベントがEmitされます。引数にはEmit時点のdayjsオブジェクトが渡されます。例えばこのイベントを受け取ってイベントの画面へリダイレクトする等の使い方ができると思います。|

## Example

README上部のGifを実現するコードは以下（`App.vue`）。

```App.vue
<template>
  <div id="app">
    <Countdownify msg="イベント" :goalTime="Date.now() + 5000" @its-time="timeup"/>
  </div>
</template>

<script>
import Countdownify from 'vue-countdownify';
import 'vue-countdownify/dist/vue-countdownify.css'

export default {
  name: 'App',
  components: {
    Countdownify
  },
  methods: {
    timeup(time) {
      console.log("time is up!")
      alert(time)
    }
  }
}
</script>

<style>
html, body {
  height: 100%;
  width: 100%;
  margin: 0;
  padding: 0;
}
#app {
  height: 100%;
}
</style>
```

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