A bootstrap-notify-simple-wrapper documentation

bootstrap-notify-simple-wrapper is a simple wrapper around bootstrap-notify (https://github.com/mouse0270/bootstrap-notify/) to make your life easier

Contents

• Installation
• Settings
• Usage
• Licensing
• Contacts

Installation

• Obtain your copy of source code from the git repository: git clone https://github.com/DCOD-OpenSource/bootstrap-notify-simple-wrapper.git. Or download the latest release from https://github.com/DCOD-OpenSource/bootstrap-notify-simple-wrapper/tags/. Or install with Bower bower install bootstrap-notify-simple-wrapper.
• Add all requirements JS and CSS files to your page.

• jquery
• bootstrap
• Font Awesome
• bootstrap-notify
• striptags.js
• underscore.js

• Add bootstrap-notify-simple-wrapper.js file to your page.
• Configure bootstrap-notify-simple-wrapper on your taste by setting some global variables listed below.

Settings

messagesCumulativeDelay

Use cumulative delay to showing a message. Defaults to: true.

messageDelay

A message showing delay (in seconds). Defaults to: 3.

messageDelayFactor

A message showing delay factor (in chars per second). Defaults to: 8.

messageIcon

Message icon css classes. Defaults to: "fa fa-exclamation-circle".

messageDefaultSettings

A message showing default settings. See documentation. Defaults to:

{
    allow_dismiss: true,
    placement: {
        from: "top",
        align: "right",
    },
    delay: 3,
    mouse_over: "pause"
}

Usage

Just:

$.showMessage("Something happened wrong :(", "danger");

or

$.showMessages([{message: "Haters gonna hate.", type: "danger"}, {message: "Spice must flow!", type: "info"}]);

Licensing

bootstrap-notify-simple-wrapper uses the MIT license. Please check the MIT-LICENSE file for more details.

Contacts

Project website: https://github.com/DCOD-OpenSource/bootstrap-notify-simple-wrapper/

Author: Alexei Andrushievich <[email protected]>

For other authors list see AUTHORS file.