You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ It is designed to work as well on touch devices such as mobile phones or tablets
29
29
## Usage
30
30
As you can see in the example files, you will need to include the JavaScript file `jquery.multiscroll.js` (or the minified version `jquery.multiscroll.min.js`) and the css file `jquery.multiscroll.css` of the plugin, as well as [jQuery](http://jquery.com/). Optionally, you can add the [jQuery UI library](http://jqueryui.com/) in case you want to use other easing effects apart from the ones included in the jQuery library which are the `linear` or `swing` effects. (`easeInQuart` is active by default, so you would need [jQuery UI library](http://jqueryui.com/) or the customized version which is included in the vendors folder under the name `jquery.easings.min.js`.)
Each section will be defined with a `div` containing the `section` class.
47
47
The active section by default will be the first section, which is taken as the home page.
48
48
```html
@@ -67,7 +67,7 @@ This should be done for the `ms-right` and `ms-left` elements.
67
67
<div class="ms-section active">Some section</div>
68
68
```
69
69
70
-
###Initialization
70
+
###Initialization
71
71
All you need to do is call the plugin inside a `$(document).ready` function:
72
72
73
73
```javascript
@@ -244,7 +244,7 @@ $.fn.multiscroll.build();
244
244
245
245
246
246
## Callbacks
247
-
###afterLoad (`anchorLink`, `index`)
247
+
###afterLoad (`anchorLink`, `index`)
248
248
Callback fired once the sections have been loaded, after the scrolling has ended.
249
249
Parameters:
250
250
@@ -273,7 +273,7 @@ Example:
273
273
});
274
274
```
275
275
276
-
###onLeave (`index`, `nextIndex`, `direction`)
276
+
###onLeave (`index`, `nextIndex`, `direction`)
277
277
This callback is fired once the user leaves a section, in the transition to the new section.
278
278
279
279
Parameters:
@@ -300,7 +300,7 @@ Example:
300
300
```
301
301
302
302
303
-
###afterRender()
303
+
###afterRender()
304
304
This callback is fired just after the structure of the page is generated. This is the callback you want to use to initialize other plugins or fire any code which requires the document to be ready (as this plugin modifies the DOM to create the resulting structure).
305
305
306
306
Example:
@@ -313,7 +313,7 @@ Example:
313
313
});
314
314
```
315
315
316
-
###afterResize()
316
+
###afterResize()
317
317
This callback is fired after resizing the browser's window. Just after the sections are resized.
0 commit comments