@3yourmind/vue-yodify

vue-yodify by 3YOURMIND

Description

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

Dependencies

Name	Version	Information
vue	^2.5.8

Installation

Using yarn

yarn add @3yourmind/vue-yodify

Using npm

npm install @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">
    <VueYodify />
    <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'
});

Architecture

Before getting into architecture, you should make sure to understand the Vue.js plugin system which is documented here.

Contributors

igeligel Contributions: 11	ostoc Contributions: 4

License

vue-yodify is realeased under the MIT License.