Skip to content
This repository has been archived by the owner on Feb 25, 2020. It is now read-only.

mykemeynell/jsnotify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JS Notify

##Requirements

  • Enabled JavaScript in browser
  • jQuery installed

##Installation

Run:

bower install jsnotify

Add the following between your projects head tags:

<!-- JsNotify Style -->
<link rel="stylesheet" href="bower_components/jsnotify/src/style.css">

And the following just before your projects closing body tag:

<!-- JsNotify Script -->
<script src="bower_components/jsnotify/src/notify.js"></script>

##Usage

var options = {
	'title': 'Oi!',
	'message': 'Whatever you did, it worked!',
	'icon': 'check',
	'style': 'success'
};

var n = new notify(options);

n.show();

##Global Config

window.JSNOTIFY_CONFIG = {
	theme: 'default'
}

##Options

Option Required Description
title No The title of the notification, this will appear at the top of the notification.
message Yes This is the body of the notification.
icon No The icon to be used within the notification, this is displayed at the left side of the notification.
style No Style of the notification. Can be default, success or error.
theme No Notification theme (only applies to the object this property is set on).
timeout No How long the notification should be available for, before automatically disppearing (null for never).

##Themes

Currently supported themes are: default and flat, these can be set on either the global config, or the instance of the notification.