Skip to content

Commit 17bd791

Browse files
authored
Merge pull request alvarotrigo#2323 from alvarotrigo/dev
Mergin Dev branch 2.8.7
2 parents 8be3a53 + b636f04 commit 17bd791

15 files changed

+197
-495
lines changed

README.md

Lines changed: 37 additions & 13 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.8.6-brightgreen.svg)
6+
![fullPage.js version](http://img.shields.io/badge/fullPage.js-v2.8.7-brightgreen.svg)
77
[![License](http://img.shields.io/badge/License-MIT-blue.svg)](http://opensource.org/licenses/MIT)
88
7Kb gziped!
99

@@ -201,6 +201,7 @@ $(document).ready(function() {
201201
afterLoad: function(anchorLink, index){},
202202
afterRender: function(){},
203203
afterResize: function(){},
204+
afterResponsive: function(isResponsive){},
204205
afterSlideLoad: function(anchorLink, index, slideAnchor, slideIndex){},
205206
onSlideLeave: function(anchorLink, index, slideIndex, direction, nextSlideIndex){}
206207
});
@@ -300,15 +301,18 @@ Embedded HTML5 `<video>` / `<audio>` and Youtube iframes are automatically paus
300301
```
301302

302303
###Use extensions
303-
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).
304+
fullpage.js [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).
304305

305-
Once you adquire the extension file, you will just need to add it before fullPage.js. For example:
306+
Extensions requires you to use the minified file `jquery.fullpage.extensions.min.js` instead of the usual fullPage.js file (`jquery.fullpage.js`).
307+
Once you adquire the extension file, you will need to add it before fullPage.js. For example:
306308

307309
```html
308310
<script type="text/javascript" src="fullpage.continuousHorizontal.min.js"></script>
309-
<script type="text/javascript" src="fullpage/jquery.fullPage.js"></script>
311+
<script type="text/javascript" src="fullpage/jquery.fullpage.extensions.min.js"></script>
310312
```
311313

314+
A license key will be required for each extension. [See more details about it here](https://github.com/alvarotrigo/fullPage.js/wiki/How-to-activate-a-fullPage.js-extension).
315+
312316
Then you will be able to use and configure them as explained in [options](https://github.com/alvarotrigo/fullPage.js#options).
313317

314318
## Options
@@ -319,7 +323,7 @@ Then you will be able to use and configure them as explained in [options](https:
319323

320324
- `scrollingSpeed`: (default `700`) Speed in milliseconds for the scrolling transitions.
321325

322-
- `sectionsColor`:(default `none`) Define the CSS `background-color` property for each section:
326+
- `sectionsColor`: (default `none`) Define the CSS `background-color` property for each section.
323327
Example:
324328
```javascript
325329
$('#fullpage').fullpage({
@@ -330,7 +334,7 @@ $('#fullpage').fullpage({
330334
- `anchors`: (default `[]`) Defines the anchor links (#example) to be shown on the URL for each section. Anchors value should be unique. The position of the anchors in the array will define to which sections the anchor is applied. (second position for second section and so on). Using anchors forward and backward navigation will also be possible through the browser. This option also allows users to bookmark a specific section or slide. **Be careful!** anchors can not have the same value as any ID element on the site (or NAME element for IE).
331335
Now anchors can be defined directly in the HTML structure by using the attribute `data-anchor` as explained here.
332336

333-
- `lockAnchors`: (default `false`). Determines whether anchors in the URL will have any effect at all in the plugin. You can still using anchors internally for your own functions and callbacks, but they won't have any effect in the scrolling of the site. Useful if you want to combine fullPage.js with other plugins using anchor in the URL.
337+
- `lockAnchors`: (default `false`) Determines whether anchors in the URL will have any effect at all in the plugin. You can still using anchors internally for your own functions and callbacks, but they won't have any effect in the scrolling of the site. Useful if you want to combine fullPage.js with other plugins using anchor in the URL.
334338

335339
**Important** It is helpful to understand that the values in the `anchors` option array correlate directly to the element with the class of `.section` by it's position in the markup.
336340

@@ -349,26 +353,26 @@ It requires the file `vendors/jquery.easings.min.js` or [jQuery UI](http://jquer
349353

350354
- `autoScrolling`: (default `true`) Defines whether to use the "automatic" scrolling or the "normal" one. It also has affects the way the sections fit in the browser/device window in tablets and mobile phones.
351355

352-
- `fitToSection`: (default `true`). Determines whether or not to fit sections to the viewport or not. When set to `true` the current active section will always fill the whole viewport. Otherwise the user will be free to stop in the middle of a section (when )
356+
- `fitToSection`: (default `true`) Determines whether or not to fit sections to the viewport or not. When set to `true` the current active section will always fill the whole viewport. Otherwise the user will be free to stop in the middle of a section (when )
353357

354358
- `fitToSectionDelay`: (default 1000). If `fitToSection` is set to true, this delays
355359
the fitting by the configured milliseconds.
356360

357-
- `scrollBar`: (default `false`). Determines whether to use scrollbar for the site or not. In case of using scroll bar, the `autoScrolling` functionality will still working as expected. The user will also be free to scroll the site with the scroll bar and fullPage.js will fit the section in the screen when scrolling finishes.
361+
- `scrollBar`: (default `false`) Determines whether to use scrollbar for the site or not. In case of using scroll bar, the `autoScrolling` functionality will still work as expected. The user will also be free to scroll the site with the scroll bar and fullPage.js will fit the section in the screen when scrolling finishes.
358362

359363
- `paddingTop`: (default `0`) Defines the top padding for each section with a numerical value and its measure (paddingTop: '10px', paddingTop: '10em'...) Useful in case of using a fixed header.
360364

361365
- `paddingBottom`: (default `0`) Defines the bottom padding for each section with a numerical value and its measure (paddingBottom: '10px', paddingBottom: '10em'...). Useful in case of using a fixed footer.
362366

363367
- `fixedElements`: (default `null`) Defines which elements will be taken off the scrolling structure of the plugin which is necessary when using the `css3` option to keep them fixed. It requires a string with the jQuery selectors for those elements. (For example: `fixedElements: '#element1, .element2'`)
364368

365-
- `normalScrollElements`: (default `null`) If you want to avoid the auto scroll when scrolling over some elements, this is the option you need to use. (useful for maps, scrolling divs etc.) It requires a string with the jQuery selectors for those elements. (For example: `normalScrollElements: '#element1, .element2'`)
369+
- `normalScrollElements`: (default `null`) If you want to avoid the auto scroll when scrolling over some elements, this is the option you need to use. (useful for maps, scrolling divs etc.) It requires a string with the jQuery selectors for those elements. (For example: `normalScrollElements: '#element1, .element2'`). This option should not be applied to any section/slide element itself.
366370

367371
- `normalScrollElementTouchThreshold` : (default `5`) Defines the threshold for the number of hops up the html node tree Fullpage will test to see if `normalScrollElements` is a match to allow scrolling functionality on divs on a touch device. (For example: `normalScrollElementTouchThreshold: 3`)
368372

369373
- `bigSectionsDestination`: (default `null`) Defines how to scroll to a section which size is bigger than the viewport. By default fullPage.js scrolls to the top if you come from a section above the destination one and to the bottom if you come from a section below the destination one. Possible values are `top`, `bottom`, `null`.
370374

371-
- `keyboardScrolling`: (default `true`) Defines if the content can be navigated using the keyboard
375+
- `keyboardScrolling`: (default `true`) Defines if the content can be navigated using the keyboard.
372376

373377
- `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
374378

@@ -412,7 +416,7 @@ $('#fullpage').fullpage({
412416

413417
- `navigationPosition`: (default `none`) It can be set to `left` or `right` and defines which position the navigation bar will be shown (if using one).
414418

415-
- `navigationTooltips`: (default []) Defines the tooltips to show for the navigation circles in case they are being used. Example: `navigationTooltips: ['firstSlide', 'secondSlide']`.
419+
- `navigationTooltips`: (default []) Defines the tooltips to show for the navigation circles in case they are being used. Example: `navigationTooltips: ['firstSlide', 'secondSlide']`. You can also define them by using the attribute `data-tooltip` in each section if you prefer.
416420

417421
- `showActiveTooltip`: (default `false`) Shows a persistent tooltip for the actively viewed section in the vertical navigation.
418422

@@ -432,15 +436,15 @@ In order to prevent fullpage.js from creating the scrollbar in certain sections
432436

433437
- `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.
434438

435-
- `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..
439+
- `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.
436440

437441
- `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.
438442

439443
- `responsiveWidth`: (default `0`) A normal scroll (`autoScrolling:false`) will be used under the defined width in pixels. A class `fp-responsive` is added to the body tag in case the user wants to use it for his own responsive CSS. For example, if set to 900, whenever the browser's width is less than 900 the plugin will scroll like a normal site.
440444

441445
- `responsiveHeight`: (default `0`) A normal scroll (`autoScrolling:false`) will be used under the defined height in pixels. A class `fp-responsive` is added to the body tag in case the user wants to use it for his own responsive CSS. For example, if set to 900, whenever the browser's height is less than 900 the plugin will scroll like a normal site.
442446

443-
- `responsiveSlides`: (default `false` ) [Extension of fullpage.js](http://alvarotrigo.com/fullPage/extensions/). When set to `true` slides will be turned into vertical sections when responsive mode is fired. (by using the `responsiveWidth` or `responsiveHeight` options detailed above). Requires fullpage.js >= 2.8.5.
447+
- `responsiveSlides`: (default `false`) [Extension of fullpage.js](http://alvarotrigo.com/fullPage/extensions/). When set to `true` slides will be turned into vertical sections when responsive mode is fired. (by using the `responsiveWidth` or `responsiveHeight` options detailed above). Requires fullpage.js >= 2.8.5.
444448

445449
## Methods
446450
You can see them in action [here](http://alvarotrigo.com/fullPage/examples/methods.html)
@@ -717,6 +721,23 @@ Example:
717721
});
718722
```
719723
---
724+
###afterResponsive(`isResponsive`)
725+
This callback is fired after fullpage.js changes from normal to responsive mode or from responsive mode to normal mode.
726+
727+
Parameters:
728+
729+
- `isResponsive`: boolean that determines if it enters into responsive mode (`true`) or goes back to normal mode (`false`).
730+
731+
Example:
732+
733+
```javascript
734+
$('#fullpage').fullpage({
735+
afterResponsive: function(isResponsive){
736+
alert("Is responsive: " + isResponsive);
737+
}
738+
});
739+
```
740+
---
720741
###afterSlideLoad (`anchorLink`, `index`, `slideAnchor`, `slideIndex`)
721742
Callback fired once the slide of a section have been loaded, after the scrolling has ended.
722743
Parameters:
@@ -809,8 +830,11 @@ Want to build fullpage.js distribution files? Please see [Build Tasks](https://g
809830
- [fullPage.js jsDelivr CDN](http://www.jsdelivr.com/#!jquery.fullpage)
810831
- [fullPage.js plugin for October CMS](http://octobercms.com/plugin/freestream-parallax)
811832
- [fullPage.js wordpress plugin](https://wordpress.org/plugins/wp-fullpage/)
833+
- [fullPage.js React implementation](https://github.com/subtirelumihail/react-fullpage)
812834
- [fullPage.js Angular2 directive](https://github.com/meiblorn/ng2-fullpage)
813835
- [fullPage.js angular directive](https://github.com/hellsan631/angular-fullpage.js)
836+
- [fullPage.js ember-cli addon](https://www.npmjs.com/package/ember-cli-fullpagejs)
837+
- [fullPage.js Rails Ruby Gem](https://rubygems.org/gems/fullpagejs-rails)
814838
- [Angular fullPage.js - Adaptation for Angular.js v1.x](https://github.com/mmautomatizacion/angular-fullpage.js)
815839
- [Integrating fullPage.js with Wordpress (Tutorial)](http://premium.wpmudev.org/blog/build-apple-inspired-full-page-scrolling-pages-for-your-wordpress-site/)
816840

dist/jquery.fullpage.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*!
2-
* fullPage 2.8.6
2+
* fullPage 2.8.7
33
* https://github.com/alvarotrigo/fullPage.js
44
* MIT licensed
55
*

dist/jquery.fullpage.extensions.min.js

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)