Skip to content

Latest commit

 

History

History
159 lines (143 loc) · 4.56 KB

README.md

File metadata and controls

159 lines (143 loc) · 4.56 KB
Raw

jQuery Notify bar

Please visit the project page for feedback and other details.

Simple plugin (basically it's not a plugin, but widget) to show notify bar (like on Twitter's webpage). It's very simple to use:

Installation

> bower install jqnotifybar

Usage

jQuery(function () {
  jQuery.notifyBar({
    html: "Thank you, your settings were updated!",
    delay: 2000,
    animationSpeed: "normal"
  });  
});

Usage position at bottom


jQuery(function () {
  jQuery.notifyBar({
    html: "Hi from below!",
    cssClass: "Appear at bottom",
    position: "bottom"
  });
});

Options

Option Description Type Default
html What text will be inside bar. Can be HTML or just text. String [optional] "Your message here"
delay How long bar will be delayed, doesn't count animation time. Integer [optional] 2000
animationSpeed How long this bar will be slided up and down. String | Integer "normal"
jqObject Custom jQuery object for notify bar. jQuery object [optional] null
cssClass You can define own CSS class for Notify bar. There are too premade classes "error", "warning" and "success". String ""
close If set to true close button will be displayed. Boolean false
closeText Sets the text to close button. String "Close [X]"
closeOnClick If enabled, user can hide notify bar just by click on it. Boolean true
closeOnOver If enabled, user can hide notify bar just by moving mouse cursor on it (suitable for really lazy people). Boolean false
waitingForClose If enabled, notify bar don't close until user presses the close button. Boolean true
onBeforeShow Callback on before show. function null
onShow Callback on show. function null
onBeforeHide Callback on before hide. function null
onHide Callback on hide. function null
position Set the position of notify bar. Possible values are top, bottom. string "top"

Please visit the project page for feedback and other details.

MIT License

The MIT License (MIT)

Copyright (c) 2009-2014 Dknight

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.