https://github.com/cosmocode/jquery-pageslide

Fork of https://github.com/srobbin/jquery-pageslide/
https://github.com/cosmocode/jquery-pageslide

Last synced: 11 months ago
JSON representation

Fork of https://github.com/srobbin/jquery-pageslide/

• Host: GitHub
• URL: https://github.com/cosmocode/jquery-pageslide
• Owner: cosmocode
• License: other
• Created: 2015-02-23T13:34:03.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-10T09:41:48.000Z (about 9 years ago)
• Last Synced: 2024-04-15T00:37:47.338Z (about 2 years ago)
• Language: HTML
• Size: 156 KB
• Stars: 10
• Watchers: 4
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.textile
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
h1. jQuery PageSlide

PageSlide is a jQuery plugin which slides a webpage over to reveal an additional interaction pane.

h2. Demo

There are a couple of examples included with this package. Or, if you can't wait to download it, see it live on the "responsive demo":http://srobbin.github.com/jquery-pageslide or "original project page":http://srobbin.com/blog/jquery-pageslide/.

h2. Options

h3. speed

The speed at which the page slides over. Accepts standard jQuery effects speeds (e.g. 'fast', 'normal' or milliseconds). (default=200)

h3. direction

Which direction does the page slide? Accepts 'left' or 'right'. (default='right')

h3. modal

By default, when pageslide opens, you can click on the document to close it. If modal is set to 'true', then you must explicitly close PageSlide using $.pageslide.close(); (default=false)

h3. iframe

By default, linked pages are loaded into an iframe. Set this to false if you don't want an iframe. (default=true)

h3. href

Override the source of the content. Optional in most cases, but required when opening pageslide programmatically (e.g. $.pageslide({ href: '#some-element' }); ) (default=null)

h2. Setup

In the HEAD tag:



Ideally, near the bottom of the page.





To use, call pageslide on an  tag that either links to a page or an anchor of a hidden element.



    $('a').pageslide();




Or, open pageslide programatically:



    $.pageslide({ href: '#some-element' });

    $.pageslide({ href: 'some-page.html' });




To close pageslide programatically:



    $.pageslide.close();




h2. Changelog

h3. Version 2.0

* Completely rewritten

* Externalized CSS

* Content loaded into an iframe

h3. Version 1.3

* Older versions of PageSlide are located in this repository, however if you would like to contribute to the original plugin's development, please use contributor "Derek Perez's repository":https://github.com/perezd/jquery-pageslide.

h2. Support

Basic support is offered through Github’s issues tracker. Many requests are resolved through the help of fellow PageSlide users and myself, however assistance is not guaranteed or timely.

If you are in need of immediate support, or would like customizations to the script, "Premium Support":https://www.paypal.com/cgi-bin/webscr?business=scott@halobrite.com&cmd=_xclick&currency_code=USD&amount=17&item_name=jQuery%20PageSlide%20Premium%20Support is available for $17. Premium Support provides you with direct email access to me, and allows me to set time aside to help solve your problem quickly.