Vue-notifikation - An Easy to Use Vue Js Notification Plugin

Vue-notifikation is a Vue js notification plugin that can be easily utilized in your application.

Installation

The library can be installed via downloading a git repo:

git clone https://github.com/happyCoda/vue-notifikation.git

You can also install this via npm, Just run this command:

$ npm install vue-notifikation

Getting started

To start using vue-notifikation, you need to do two things. First, write some HTML:

<div id="notifikation"></div>

You can use any id or even class. This is not necessary, but if you won’t do this, the plugin will have to go to the DOM and create this HTML for you. The second thing to do is plugin installation:

// Somewhere in your main js file
import VueNotifikation from 'vue-notifikation';
// Then install the plugin to Vue
Vue.use(VueNotifikation);

Usage

Using vue-notifikation is pretty straightforward. Just call one of the API methods provided.

// After you've install the plugin, you can use it in any component
export default {
  name: 'SupaDupaComponent',
  data() {
    //...
  },
  methods: {
    someVeryUsefullMethod() {
      // That's it!
      this.$notifikation.show(options);
    }
  }
}

API

There are 4 methods for calling notifications and one for dismissing them.

show

Generic method. Can create notifications of any level (error, success, or info);

this.$notifikation.show(options);

error

As its name says, the error method creates error-level notifications.

this.$notifikation.error(options);

success

This method creates notifications for any good news.

this.$notifikation.success(options);

info

Use the info method whenever you need some regular notification.

this.$notifikation.info(options);

dismiss

To close notifikation bubble call dismiss method. The method accepts a single parameter – notifikationId. This parameter is optional, and if omitted, all notifications will be dismissed.

this.$notifikation.dismiss(notifikationId);

Options

All 4 API methods expect options object with some configuration data to set up notification.

Examples

Let’s create notifications for some successful events.

export default {
  name: 'AnotherOneGreatestComponent',
  data() {
    //...
  },
  methods: {
    veryImportantMethod() {
      // That's it!
      this.$notifikation.success({
        message: `You've just von 1 000 000$!!!`
      });
    }
  }
}

You can visit Github for source code and more information.