Skip to content

Commit ca5bc6e

Browse files
committed
- Extensions documentation
1 parent 42ef0a2 commit ca5bc6e

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It allows the creation of fullscreen scrolling websites, as well as adding some
1212

1313
- [Live demo](http://alvarotrigo.com/fullPage/)
1414
- [Wordpress theme](https://goo.gl/HuFudq)
15-
- [Blog Article](http://alvarotrigo.com/blog/fullpage-jquery-plugin-for-fullscreen-scrolling-websites/)
15+
- [fullpage.js Extensions](http://alvarotrigo.com/fullPage/extensions/)
1616
- [Frequently Answered Questions](https://github.com/alvarotrigo/fullPage.js/wiki/FAQ---Frequently-Answered-Questions)
1717

1818
Invite me to a coffee
@@ -30,6 +30,7 @@ Would you like to have a website using fullpage.js functionality but you don't k
3030
- [State classes added by fullpage.js](https://github.com/alvarotrigo/fullPage.js#state-classes-added-by-fullpagejs)
3131
- [Lazy loading](https://github.com/alvarotrigo/fullPage.js#lazy-loading)
3232
- [Autoplay embedded media](https://github.com/alvarotrigo/fullPage.js#auto-playpause-embedded-media)
33+
- [Use extensions](https://github.com/alvarotrigo/fullPage.js#use-extensions)
3334
- [Options](https://github.com/alvarotrigo/fullPage.js#options)
3435
- [Methods](https://github.com/alvarotrigo/fullPage.js#methods)
3536
- [Callbacks](https://github.com/alvarotrigo/fullPage.js#callbacks)
@@ -163,6 +164,10 @@ $(document).ready(function() {
163164
loopTop: false,
164165
loopHorizontal: true,
165166
continuousVertical: false,
167+
continuousHorizontal: false,
168+
scrollHorizontally: false,
169+
interlockedSlides: false,
170+
resetSliders: false,
166171
normalScrollElements: '#element1, .element2',
167172
scrollOverflow: false,
168173
scrollOverflowOptions: null,
@@ -292,6 +297,17 @@ Embedded HTML5 `<video>` / `<audio>` and Youtube iframes are automatically paus
292297
</audio>
293298
```
294299

300+
###Use extensions
301+
fullpage.js (since version 2.8.3) [provides a set of extensions](http://alvarotrigo.com/fullPage/extensions/) you can use to enhance its default features. All of them are listed as [fullpage.js options](https://github.com/alvarotrigo/fullPage.js#options).
302+
303+
Once you adquire the extension file, you will just need to add it before fullPage.js. For example:
304+
305+
```html
306+
<script type="text/javascript" src="fullpage.continuousHorizontal.min.js"></script>
307+
<script type="text/javascript" src="fullpage/jquery.fullPage.js"></script>
308+
```
309+
310+
Then you will be able to use and configure them as explained in [options](https://github.com/alvarotrigo/fullPage.js#options).
295311

296312
## Options
297313

@@ -354,7 +370,15 @@ the fitting by the configured milliseconds.
354370

355371
- `touchSensitivity`: (default `5`) Defines a percentage of the browsers window width/height, and how far a swipe must measure for navigating to the next section / slide
356372

357-
- `continuousVertical`: (default `false`) Defines whether scrolling down in the last section should scroll down to the first one or not, and if scrolling up in the first section should scroll up to the last one or not. Not compatible with `loopTop` or `loopBottom`.
373+
- `continuousVertical`: (default `false`) Defines whether scrolling down in the last section or should scroll down to the first one or not, and if scrolling up in the first section should scroll up to the last one or not. Not compatible with `loopTop` or `loopBottom`.
374+
375+
- `continuousHorizontal`: (default `false`) [Extension of fullpage.js](alvarotrigo.com/fullPage/extensions/). Defines whether sliding right in the last slide should slide right to the first one or not, and if scrolling left in the first slide should slide left to the last one or not. Not compatible with `loopHorizontal`. Requires fullpage.js >= 2.8.3.
376+
377+
- `scrollHorizontally`: (default `false`) [Extension of fullpage.js](alvarotrigo.com/fullPage/extensions/). Defines whether to slide horizontally within sliders by using the mouse wheel or trackpad. Ideal for story telling`. Requires fullpage.js >= 2.8.3.
378+
379+
- `interlockedSlides`: (default `false`) [Extension of fullpage.js](alvarotrigo.com/fullPage/extensions/). Determines whether moving one horizontal slider will force the sliding of sliders in other section in the same direction. Possible values are `true`, `false` or an array with the interlocked sections. For example `[1,3,5]` starting by 1. Requires fullpage.js >= 2.8.3.
380+
381+
- `resetSliders`: (efault `false`). [Extension of fullpage.js](alvarotrigo.com/fullPage/extensions/). Deefines whether or not to reset every slider after leaving its section. Requires fullpage.js >= 2.8.3.
358382

359383
- `animateAnchor`: (default `true`) Defines whether the load of the site when given an anchor (#) will scroll with animation to its destination or will directly load on the given section.
360384

0 commit comments

Comments
 (0)