Skip to content

Commit 4ec0d4e

Browse files
author
Ahmed Radwan
committed
updating docs for auto_close option
1 parent 1f5c4a3 commit 4ec0d4e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The plugin is built on jQuery 2.1.0 but could potentially work with older and ne
1313
##How to use it?
1414
1- Download the sliiide js file (or the minified version) from the github repo, include the js file before the body end tag and make sure jQuery is included before it. Or just use bower "bower install sliiide"
1515

16-
2- you’ll need a div (a nav menu or whatever you have in mind) and set its visibility to hidden. PLEASE MAKE SURE THIS DIV IS A DIRECT CHILD OF THE BODY ELEMENT. You also need a settings object.
16+
2- you’ll need a div (a nav menu or whatever you have in mind) and set its visibility to hidden. PLEASE MAKE SURE THIS DIV IS A DIRECT CHILD OF THE BODY ELEMENT. You also need a settings object.
1717
```
1818
var settings = {
1919
toggle: "#sliiider-toggle", // the selector for the menu toggle, whatever clickable element you want to activate or deactivate the menu. A click listener will be added to this element.
@@ -22,7 +22,8 @@ The plugin is built on jQuery 2.1.0 but could potentially work with older and ne
2222
place: "left", //where is the menu sliding from, possible options are (left | right | top | bottom)
2323
animation_curve: "cubic-bezier(0.54, 0.01, 0.57, 1.03)", //animation curve for the sliding animation
2424
body_slide: true, //set it to true if you want to use the effect where the entire page slides and not just the div
25-
no_scroll: true //set to true if you want the scrolling disabled while the menu is active
25+
no_scroll: true, //set to true if you want the scrolling disabled while the menu is active
26+
auto_close: false //set to true if you want the slider to auto close everytime a child link of it is clicked
2627
};
2728
2829
$(‘#menu’).sliiide(settings); //initialize sliiide
@@ -38,4 +39,3 @@ The plugin is built on jQuery 2.1.0 but could potentially work with older and ne
3839
menu.reset(); //removes all the css that sliiide added to any element
3940
```
4041
That’s it, you now should be good to go, feel free to report back any issues you encounter I’m happy to continue working on this.
41-

0 commit comments

Comments
 (0)