Overthrow plugin
A jQuery plugin to open a very simple modal using content from within the page or loaded via ajax. See an example at http://code.sneak.co.nz/overthrow/.
Usage
For any link that you want to open in an overthrow layer, set the href
attribute to be the content you wish to load and then call .overthrow()
for it. This plugin is only simple, and is set up to accept hrefs that are either a class/id which reference HTML elements within the current page (e.g. '#content
' or '.content
', for which the overthrow will load the contents of this element) or else an external fragment of HTML specified by a URL (e.g. http://mysite.com/content.html
).
<a href="#content">Open my inline content</a> <a href="http://mysite.com/content.html">Open my external content</a>
And the javascript to call the plugin:
$('a').overthrow();
You can optionally pass in some settings via options when calling overthrow()
, or for the customClass
option you can optionally use a data attribute on the link.
$('a').overthrow({ customClass: 'myclass', afterLoad: function(){ alert('hello!'); }, disableForTouch: true, duration: 300 });
Note: The show & hide transitions use CSS and corresponding javascript delays to match, so edit at your own peril. If you change or remove the CSS transitions, be sure to poke around and update the javascript also.
Options
customClass | A class that will be added to the overthrow wrapper. This can be specified in the settings object, or else as a data attribute on the link with the name data-overthrow-class |
---|---|
afterLoad | A callback that gets called once the content is added to the overthrow. This is useful if you need to run any javascript against the content before displaying it. |
disableForTouch | Boolean, defaults to false . When set to true , Overthrow is disabled when on a touch device. |
duration | The duration (ms) of the animation transition in/out. Defaults to 200 . Note that transitions only get applied if the browser supports CSS transitions, and the transitions are controlled by the addition/removal of CSS classes. |
To-do
- Add loading indicator while ajax content is retrieved