Code Monkey home page Code Monkey logo

notific8's Introduction

notific8

Build Status

Notific8 is a notification JavaScript plug-in. Notific8 has built in themes that each come with a set of built in colors. The plug-in is designed to be easy to create new themes and colors for. The plug-in was born from a want for a simply designed yet modern and stylish notification system that was easily customizable.

As of version 3.0.0, the plug-in was rewritten in pure JavaScript (via CoffeeScript) to be compatible with many of today's JavaScript frameworks that do not play well with jQuery. A jQuery wrapper is also provided to allow existing code to function properly with the new version. The minified version of the jQuery wrapper jquery.notific8.min.js has a copy of the notific8 code included so that developers only have to include one file in their project or build script. The unminified files are also available for use in custom build scripts as well.

Install with Bower

$ bower install notific8 --save

Install with NPM

$ npm install notific8 --save

Demo page

An interactive demo page can be found in the ./demo/ directory.

Features

  • Notifications slide in and out from the upper right corner of the page
  • Configurable life span of the notification
  • Option to display a heading
  • Built in theme options with ability to create custom themes (see CSS for built in themes)
  • Ability to make the notification sticky
  • Ability to set up custom settings for reuse without having to type them over and over
  • Ability to set which corner the notifications are shown in
  • Ability to set the z-index
    • Can be set via config/configure or the zindex function
  • Ability to customize close text on sticky notifications
  • Ability to set custom CSS namespace if necessary
  • Events for init, create, and close
  • Modular system to make it easier for developers to extend the plug-in
  • Ability to queue notifications

Officially Supported modules

  • icon - adds the ability to select an icon to display in the notification
  • image - adds the ability to use an image in the notification
  • closeAll - adds a "Close All" button to the container if more than one notification is visible

Browser support

Currently supported and testing:

  • Chrome
  • Firefox
  • Safari (Mac only)
  • IE 10+
  • Edge

While not tested, this plug-in should work on Opera versions released after the rewrite on the blink rendering engine.

Browser version support

As a rule of thumb, only the most recent plus one version older of a browser is supported unless marked otherwise. While it may work in IE8 and IE9, notific8 will not be tested or officially supported in legacy browsers such as versions of IE older than 10.

Wiki

Please view the wiki for information on:

  • The options available and how to implement them
  • How to create modules to extend the plug-in

Future development

All planned features can be viewed by visiting the issues page.

Styles

The styles are written in Scss format and available in the src/sass directory. The grunt task release will create versions of the code in Sass format, Less, and Stylus. Development will continue in Scss only - please do not open issues or pull requests to change the default style format.

NOTE: the automatic generation of alternate styles via the release task will be removed from the base release in version 4.0.0. At this time, the alternate styles will still be available for transpiling through Grunt tasks.

Contributing

When contributing, create a feature branch from develop. Ensure that all existing tests are still passing. If appropriate, be sure to write new tests. When a pull request is created, ensure that it is requested to go into develop and not master.

License

The notific8 plug-in is released under the BSD license.

(c) 2013-2016 Ralivue

notific8's People

Contributors

willsteinmetz avatar dan-luk avatar liingon avatar

Watchers

James Cloos avatar yangsong158 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.