@3yourmind/vue-yodify

A Vue.js notification plugin with easy installation and usage

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@3yourmind/vue-yodify
Minified + gzip package size for @3yourmind/vue-yodify in KB

Readme

vue-yodify by 3YOURMIND

Description

A simple Vue.js plugin to enable notifications with ease.

Dependencies

Name Version Information
vue 2.x

Installation

yarn add @3yourmind/vue-yodify

or

npm i @3yourmind/vue-yodify

How to use

You need to register this library as a plugin. So you need to find the file where you are registering Vue.js. In the most common case this will be the file src/main.js. Inside this file you need to import this library and bind it to Vue.js.

import Vue from 'vue';
import VueYodify from '@3yourmind/vue-yodify';

Vue.use(VueYodify);

Then you need to register a global component in your app so the library can find the component somehow. To do this go to your root component and extend it by using the component once.

<template>
  <div id="app">
    <vue-yodify />
    <router-view />
  </div>
</template>

<script>
export default {
  name: 'app',
};
</script>

After registering the component you can call it globally by using the Vue instance in the script part of a component.

this.$yodify({
  text: 'This was successful :)',
  type: 'success', // optional, default
  duration: 3000, // optional, default
});

Contributors


igeligel

Contributions: 11


ostoc

Contributions: 4


dodekeract

Contributions: 12

License

vue-yodify is released under the MIT License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.