# vue-template-plugin

> A template for create a Vue Plugin with Rollup

Latest version **0.1.0-beta.1** (published 2019-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-template-plugin
pnpm add vue-template-plugin
yarn add vue-template-plugin
bun add vue-template-plugin
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-beta.1 |
| Published | 2019-07-07 |
| First published | 2019-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Javier Diaz Chamorro |
| Maintainers | coderdiaz |
| Keywords | vue, vuejs, vue-component, component, vue.js |

## Links

- npm: https://www.npmjs.com/package/vue-template-plugin
- Repository: https://github.com/coderdiaz/vue-template-plugin
- Homepage: https://github.com/coderdiaz/vue-template-plugin#readme
- Issues: https://github.com/coderdiaz/vue-template-plugin/issues
- npm.io page: https://npm.io/package/vue-template-plugin

## Dependencies (1)

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

## Recent versions

- 0.1.0-beta.1 (latest) — 2019-07-07
- 0.1.0-beta.0 — 2019-07-02

## README

<p align="center">
  <a href="#"><img src="https://vuejs.org/images/logo.png" width="120"></a>
  <h2 align="center">&lt;vue-template-plugin&gt;</h2>
</p>

<p align="center">A template for create a Vue Plugin with Rollup</p>

<p align="center">
    <a href="https://npmjs.com/package/vue-template-plugin"><img src="https://img.shields.io/npm/dt/vue-template-plugin.svg?style=flat-square"></a>
    <a href="https://github.com/coderdiaz/vue-template-plugin/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"></a>
    <a href="https://github.com/coderdiaz/vue-template-plugin/stargazers"><img src="https://img.shields.io/github/stars/coderdiaz/vue-template-plugin.svg?style=flat-square"></a>
    <a href="http://npmjs.com/package/vue-template-plugin"><img src="https://img.shields.io/npm/v/vue-template-plugin.svg?style=flat-square"></a>
    <a href="http://npmjs.com/package/vue-template-plugin"><img src="https://img.shields.io/npm/dm/vue-template-plugin.svg?style=flat-square"></a>
</p>

---

## Install/Usage
<!-- Replace the docs for usage the plugin -->
```sh
# Install with npm
$ npm i -S vue-template-plugin

# or yarn
$ yarn add vue-template-plugin
```

```html
<div id="app">
  <HelloWorld :message="message" />
</div>
```

You can use **Local Registration**:
```js
import { HelloWorld } from 'vue-template-plugin';
new Vue({
  el: '#app',
  data() {
    return {
      message: 'Hello World',
    };
  },
  components: {
    HelloWorld,
  },
});
```

or **Global Registration**:
```js
import HelloWorld from 'vue-template-plugin';
Vue.use(HelloWorld);

// or with a custom component name
import { HelloWorld } from 'vue-template-plugin';
Vue.component('custom-hello-world', HelloWorld);
```

### Usage in browser
<!-- Write an example for use the plugin in browser from CDN -->
In browser you can use Unpkg, Jsdelivr, CDN.js, etc.
```sh
# Unpkg
https://unpkg.com/vue-template-plugin@latest/dist/vue-template-plugin.js

# JSDelivr
https://cdn.jsdelivr.net/npm/vue-template-plugin@latest/dist/vue-template-plugin.min.js
```

## Documentation
<!-- Add all documentation about the plugin: props, events, etc -->
### Props
|Name|Description|Type|Required|
|---|---|---|---|
|message|The message property that will be displayed|String|false|

## Community
All feedback and suggestions are welcome!

## License
This is a open-source software licensed under the [MIT license](https://raw.githubusercontent.com/coderdiaz/vue-template-plugin/master/LICENSE)

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