LarsVonQualen / AlertJS

Easy javascript notification and alert system.

Home Page:http://larsvonqualen.github.io/AlertJS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AlertJS

Easy javascript notification and alert system.

Features

  • Custom modal alerts.
  • Notifications popping up in the bottom right corner.
  • Notifications popping down from the top of the page.
  • Pre DOM ready queue, that fires at DOM ready.
  • Four different notification sounds.

Example

An example page can be found here: http://larsvonqualen.github.io/AlertJS/example/

How To

The library is very simple to use. Make sure you include the css in the header, and the javascript in the end of the <body> tag AFTER jQuery, and you are ready to pop some notifications or alerts!

In order to show a notification, simply use one of the following calls, with the appropriate type:

AlertJS.Notify.Info("Some Title", "Some informational message.");
AlertJS.Notify.Warning("Some Title", "Some warning message.");
AlertJS.Notify.Error("Some Title", "Some error message.");
AlertJS.Notify.Success("Some Title", "Some success message.");

If you want the notification to come down from the top, you simply call the library like this:

AlertJS.Notify.Top.Info("Some Title", "Some informational message.");
AlertJS.Notify.Top.Warning("Some Title", "Some warning message.");
AlertJS.Notify.Top.Error("Some Title", "Some error message.");
AlertJS.Notify.Top.Success("Some Title", "Some success message.");

If you want to show a modal alert, you simply make one of the following calls:

AlertJS.Alert.Info("Some Title", "Some informational message.");
AlertJS.Alert.Warning("Some Title", "Some warning message.");
AlertJS.Alert.Error("Some Title", "Some error message.");
AlertJS.Alert.Success("Some Title", "Some success message.");

Sound

The lib supports playing four different sounds, according to each notification type. The sound is activated either through global settings:

AlertJS.setSetting("sound", true);

or by adding a boolean value to the notification call, like so:

AlertJS.Notify.Info("Some Title", "Some informational message.", true);

In order to include actual sound data either include the alertjs.sounds.js file, or inject base64 encoded data or url's into the appropriate setting like this:

AlertJS.setSetting("sounds", {
    error: {
        mp3: "base64_encoded_data",
        ogg: "http://some.url.com"
    }
});

This can be done for all four alert types: error, info, warning, success. If in doubt, look in the alertjs.sounds.js file.

For further details, check of the example.html file.

Dependencies

  • jQuery (only tested with 2.0.3)

Credits

About

Easy javascript notification and alert system.

http://larsvonqualen.github.io/AlertJS

License:MIT License


Languages

Language:JavaScript 99.9%Language:CSS 0.1%