Skip to content

Commit fb88394

Browse files
alvarotrigoalvarotrigo
committed
- Updated dist files and others
- Documented iScroll.js
1 parent 0460b69 commit fb88394

12 files changed

+431
-286
lines changed

‎README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
![preview](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/intro.png)
44
![compatibility](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/compatible.gif)
55

6-
![fullPage.js version](http://img.shields.io/badge/fullPage.js-v2.7.9-brightgreen.svg)
6+
![fullPage.js version](http://img.shields.io/badge/fullPage.js-v2.8.0-brightgreen.svg)
77
[![License](http://img.shields.io/badge/License-MIT-blue.svg)](http://opensource.org/licenses/MIT)
88
7Kb gziped!
99

@@ -30,11 +30,11 @@ Would you like to have a website using fullpage.js functionality but you don't k
3030
- [Introduction](https://github.com/alvarotrigo/fullPage.js#introduction)
3131
- [Compatibility](https://github.com/alvarotrigo/fullPage.js#compatibility)
3232
- [Usage](https://github.com/alvarotrigo/fullPage.js#usage)
33-
- [Creating links to sections or slides](https://github.com/alvarotrigo/fullPage.js/tree/dev#creating-links-to-sections-or-slides)
33+
- [Creating links to sections or slides](https://github.com/alvarotrigo/fullPage.js#creating-links-to-sections-or-slides)
3434
- [Creating smaller sections](https://github.com/alvarotrigo/fullPage.js#creating-smaller-sections)
3535
- [State classes added by fullpage.js](https://github.com/alvarotrigo/fullPage.js#state-classes-added-by-fullpagejs)
3636
- [Lazy loading](https://github.com/alvarotrigo/fullPage.js#lazy-loading)
37-
- [Autoplay embedded media](https://github.com/alvarotrigo/fullPage.js#)
37+
- [Autoplay embedded media](https://github.com/alvarotrigo/fullPage.js#auto-playpause-embedded-media)
3838
- [Options](https://github.com/alvarotrigo/fullPage.js#options)
3939
- [Methods](https://github.com/alvarotrigo/fullPage.js#methods)
4040
- [Callbacks](https://github.com/alvarotrigo/fullPage.js#callbacks)
@@ -91,7 +91,7 @@ npm install fullpage.js
9191

9292

9393
<!-- This following line is only necessary in the case of using the plugin option `scrollOverflow:true` -->
94-
<script type="text/javascript" src="vendors/jquery.slimscroll.min.js"></script>
94+
<script type="text/javascript" src="vendors/scrolloverflow.min.js"></script>
9595

9696
<script type="text/javascript" src="jquery.fullPage.js"></script>
9797
```
@@ -170,6 +170,7 @@ $(document).ready(function() {
170170
continuousVertical: false,
171171
normalScrollElements: '#element1, .element2',
172172
scrollOverflow: false,
173+
scrollOverflowOptions: null,
173174
touchSensitivity: 15,
174175
normalScrollElementTouchThreshold: 5,
175176

@@ -392,14 +393,16 @@ $('#fullpage').fullpage({
392393

393394
- `slidesNavPosition`: (default `bottom`) Defines the position for the landscape navigation bar for sliders. Admits `top` and `bottom` as values. You may want to modify the CSS styles to determine the distance from the top or bottom as well as any other style such as color.
394395

395-
- `scrollOverflow`: (default `false`) defines whether or not to create a scroll for the section in case its content is bigger than the height of it. When set to `true`, your content will be wrapped by the plugin. Consider using delegation or load your other scripts in the `afterRender` callback.
396-
In case of setting it to `true`, it requires the vendor plugin [`jquery.slimscroll.min`](https://github.com/rochal/jQuery-slimScroll) and it should be loaded before the fullPage.js plugin. For example:
396+
- `scrollOverflow`: (default `false`) defines whether or not to create a scroll for the section/slide in case its content is bigger than the height of it. When set to `true`, your content will be wrapped by the plugin. Consider using delegation or load your other scripts in the `afterRender` callback.
397+
In case of setting it to `true`, it requires the vendor library [`scrolloverflow.min.js`](https://github.com/alvarotrigo/fullPage.js/vendors) and it should be loaded before the fullPage.js plugin. For example:
397398

398399
```html
399-
<script type="text/javascript" src="vendors/jquery.slimscroll.min.js"></script>
400+
<script type="text/javascript" src="vendors/scrolloverflow.min.js"></script>
400401
<script type="text/javascript" src="jquery.fullPage.js"></script>
401402
```
402403

404+
- `scrollOverflowOptions`: when using scrollOverflow:true fullpage.js will make use of a forked and modified version of [iScroll.js libary](https://github.com/cubiq/iscroll/). You can customize the scrolling behaviour by providing fullpage.js with the iScroll.js options you want to use. Check [its documentation](http://iscrolljs.com/) for more info.
405+
403406
- `sectionSelector`: (default `.section`) Defines the jQuery selector used for the plugin sections. It might need to be changed sometimes to avoid problem with other plugins using the same selectors as fullpage.js..
404407

405408
- `slideSelector`: (default `.slide`) Defines the jQuery selector used for the plugin slides. It might need to be changed sometimes to avoid problem with other plugins using the same selectors as fullpage.js.

0 commit comments

Comments
 (0)