Avgrund is a jQuery plugin for your modal boxes and popups. It uses new concept showing depth between popup and page.
It works in all modern browsers and gracefully degrade in those that do not support CSS transitions and transformations.
Tested with jQuery versions 1.4+
File size of minified version is
avgrund.css file to the project:
If you use bower then you can simply install it as:
bower install jquery.avgrund
At first install plugin via NPM:
npm install jquery.avgrundnpm install jquery-browserify
In your server-side node.js (e.g. express app):
And in your browser-side you can init plugin now:
var $ = ;$;
You're also able to use some of the options that let you customize it as you wish:
More detailed information on every option you can find here.
Here is the list of available avgrund options:
width - string | number, default: '380px'
Set popup width (currently stict to max
height - string | number, default: '280px'
Set popup height (currently strict to max
showClose - boolean, default: false
Show/hide close button.
showCloseText - string
If you decided to show close button then you probably want to add close text to it.
closeByEscape - boolean, default: true
Allow users to close popup by clicking
closeByDocument - boolean, default: true
Allow users to close popup by clicking everywhere on
document (except popup of course).
holderClass - string
Adds custom css classes to avgrund popup, example:
results in adding this class to avgrund container:
overlayClass - string
Adds custom css classes to avgrund overlay container.
enableStackAnimation - boolean, default: false
Possibility to add a bit different popup hiding animation type.
onBlurContainer - string
Class name for container element that will be blurred when popup appears, example:
Please note that currently css
blur is not supported in all modern browsers.
openOnEvent - boolean, default: true
If you want to show avgrund on page load set this option value to
setEvent - string, default: 'click'
With this option you can manage events that will open popup on certain element:
onLoad - function
If you need to make some preparations or whatever before avgrund popup will be shown, example:
onUnload - function
This function will be executed after popup was closed, example:
template - string | function | jQuery object
Specify your content for popin here, it can be
function that returns content itself:
Also it accepts jQuery objects (dynamic as well), so you can create element with content inside your app:
My content for popin!
and use it in
template of popin:
Check the example here: http://labs.voronianski.com/jquery.avgrund.js/
Inspired by Hakim's demo: https://github.com/hakimel/avgrund/
Update (Sep 28, 2013)
Added AMD and CommonJS styles support.
Update (Sep 22, 2013)
Added support jQuery selectors in template option.
Update (June 15, 2013)
Better fix for overlay and long content pages, minor add-ons.
Update (May 26, 2013)
Few fixes, and plugin is available as bower package now. So you can simply install it as:
Update (Feb 25, 2013)
A bunch of small but very useful fixes and updates, including multiple avgrund popins on a page, removing popins from DOM after deactivation (also fixed an issue to make sure avgrund close effect works) and position:fixed/transform/overflow issue for scrolled pages in -webkit.
Update (Nov 18, 2012)
Get 2 new useful options for popin that were missed before. Now you can set your custom functions before Avgrund dialog is open and after it was closed.
Update (Sep 30, 2012)
Some new updates include initializing popin without event. Also now you can set up your own event for an element. Added ability to use a custom function inside avgrund's template option. Thanks to juice49 for pull request.
Update (Aug 31, 2012)
New options added - disable closing popup by 'Esc' and 'Document click'. Blur css filter for browsers that support it (seems only webkit ones for now).
We still have some issues to fix and make avgrund better, if you have any suggestions raise them in issues please.