A Vue JS wrapper around Noty
JavaScript HTML Vue CSS
Switch branches/tags
Nothing to show
Latest commit fb8bb7f Jun 13, 2017 @renoguyon renoguyon 0.1.2 build
Permalink
Failed to load latest commit information.
build Extract and build css Jun 9, 2017
dev Extract and build css Jun 9, 2017
dist 0.1.2 build Jun 12, 2017
src Allow usage outside of a component Jun 12, 2017
.babelrc Initial commit Jun 8, 2017
.editorconfig Initial commit Jun 8, 2017
.gitignore Initial commit Jun 8, 2017
README.md Minor readme update Jun 9, 2017
package-lock.json 0.1.2 Jun 12, 2017
package.json 0.1.2 Jun 12, 2017

README.md

vuejs-noty

A Vue JS wrapper around Noty. Developped for Vue 2.

Getting Started

Install using npm:

$ npm install vuejs-noty

Import and register Vue plugin:

import Vue from 'vue'
import VueNoty from 'vuejs-noty'

Vue.use(VueNoty)

Import noty styles

Import stylesheet in your vue / js components:

import 'vuejs-noty/dist/vuejs-noty.css'

Or, import styles in your less / scss stylesheet:

@import '~vuejs-noty/dist/vuejs-noty.css';

Usage

In your Vue.js components, simply call one of these methods:

// Basic alert
this.$noty.show("Hello world!")

// Success notification
this.$noty.success("Your profile has been saved!")

// Error message
this.$noty.error("Oops, something went wrong!")

// Warning
this.$noty.warning("Please review your information.")

// Basic alert
this.$noty.info("New version of the app is available!")

Configuration

Config defaults

You can set a default configuration object when registering the plugin. Example:

Vue.use(VueNoty, {
  timeout: 4000,
  progressBar: true,
  layout: 'topCenter'
})

Config override

All of the alert methods can accept a config object as second parameter if you need to override the defaults. Example:

this.$noty.info("Hey! Something very important here...", {
  killer: true,
  timeout: 6000,
  layout: 'topRight'
})

For more information about available configuration properties, please read Noty's documentation.