# vue3-damp-fireworks

> A Vue3 based fireworks component

Latest version **1.0.6** (published 2023-02-14) · 0 weekly downloads

## Install

```sh
npm install vue3-damp-fireworks
pnpm add vue3-damp-fireworks
yarn add vue3-damp-fireworks
bun add vue3-damp-fireworks
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-02-14 |
| First published | 2023-02-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 728.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dampion |
| Maintainers | parkerisme |
| Keywords | vue3, firework, vue3 firework, 煙火, 烟花, 烟火, 爆竹 |

## Links

- npm: https://www.npmjs.com/package/vue3-damp-fireworks
- npm.io page: https://npm.io/package/vue3-damp-fireworks

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^3.2.37

## Recent versions

- 1.0.6 (latest) — 2023-02-14
- 1.0.5 — 2023-02-14
- 1.0.4 — 2023-02-14
- 1.0.3 — 2023-02-14
- 1.0.2 — 2023-02-14

## README

# vue3-damp-firework
The interesting component for Vue developers.
<!-- <p align="center"><img src="/dampion/Vue-damp-fireworks/raw/master/public/fireworks.gif" alt="Vue dampion fireworks"></p> -->

## Contribution Guide

### Installation
#### Vue2
```bash
# install packages
yarn add vue-damp-fireworks
or
npm install vue-damp-fireworks
```

#### Vue3
```bash
# install packages
yarn add vue3-damp-fireworks
or
npm install vue3-damp-fireworks
```

### Vue2
```javascript
# global registered in main.js 
import VueFireworks from 'vue-damp-fireworks'
Vue.use(VueFireworks)

# Usage in .vue
<vue-damp-fireworks />
<vue-damp-fireworks :boxHeight="500" :boxWidth="500"/>
<vue-damp-fireworks :boxHeight="500" :boxWidth="500">
    <p>add any element you want</p>
</vue-damp-fireworks>
```

### Vue3
```javascript
# global registered in main.js 
import { createApp } from 'vue'
import App from './App.vue'
import VueFireworks from 'vue3-damp-fireworks'
createApp(App).use(VueFireworks)

# Usage in .vue
<vue-damp-fireworks />
<vue-damp-fireworks :boxHeight="500" :boxWidth="500"/>
<vue-damp-fireworks :boxHeight="500" :boxWidth="500">
    <p>add any element you want</p>
</vue-damp-fireworks>
```

### Component Props

All parameters are optional and fireworks determines the default value of each prop.

| Prop Name       | vue-damp-fireworks Doc & Description                                                     | Type                   | default |
| :-------------- | :--------------------------------------------------------------------------------------- | :--------------------- | :------ |
| boxHeight       | decides the height of the component                                                      | `Number`               | 500     |
| boxWidth        | decides the width of the component                                                       | `Number`               | 500     |
| duration        | decides the duration(ms) of the animation                                                | `Number`               |         |


## Demo Page
[Click me to watch the fireworks](https://dampion.github.io/Vue3-damp-fireworks/)

<p align="right">
  <a href="https://www.buymeacoffee.com/dampion" target="_blank" rel="noopener noreferrer">
    <img width="200" src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" />
  </a>
</p>

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