Skip to content

Commit 3cc7d23

Browse files
alvarotrigoalvarotrigo
authored
Merge pull request alvarotrigo#2589 from alvarotrigo/dev
Merging dev branch
2 parents 9ad4255 + 785a271 commit 3cc7d23

13 files changed

+147
-140
lines changed

‎README.md

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
# fullPage.js
2-
32
![preview](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/intro.png)
4-
![compatibility](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/compatible.gif)
3+
![compatibility](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/compatible.gif?v=2)
54

65
<p align="center">
76
<a href="https://github.com/alvarotrigo/fullPage.js"><img src="https://raw.githubusercontent.com/alvarotrigo/fullPage.js/dev/examples/imgs/en-language.png" /></a><a href="https://github.com/alvarotrigo/fullPage.js/blob/dev/README_SPANISH.md#fullpagejs"><img src="https://raw.githubusercontent.com/alvarotrigo/fullPage.js/dev/examples/imgs/es-language-inactive.png" /></a>
87
</p>
9-
10-
![fullPage.js version](http://img.shields.io/badge/fullPage.js-v2.9.2-brightgreen.svg)
8+
![fullPage.js version](http://img.shields.io/badge/fullPage.js-v2.9.3-brightgreen.svg)
119
[![License](http://img.shields.io/badge/License-MIT-blue.svg)](http://opensource.org/licenses/MIT)
12-
7Kb gziped!
10+
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/alvarotrigo/9.95)
11+
&nbsp;&nbsp; **|**&nbsp;&nbsp; *7Kb gziped* &nbsp;&nbsp;**|**&nbsp;&nbsp; *Created by [@imac2](https://twitter.com/imac2)*
1312

14-
A simple and easy to use plugin to create fullscreen scrolling websites (also known as single page websites or onepage sites).
13+
A simple and easy to use libary to create fullscreen scrolling websites (also known as single page websites or onepage sites).
1514
It allows the creation of fullscreen scrolling websites, as well as adding some landscape sliders inside the sections of the site.
1615

1716
- [Live demo](http://alvarotrigo.com/fullPage/)
@@ -22,9 +21,7 @@ It allows the creation of fullscreen scrolling websites, as well as adding some
2221
Invite me to a coffee
2322
[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=fullPage%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
2423

25-
Customizations of the plugin and urgent changes are available upon request for some reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
26-
27-
Would you like to have a website using fullpage.js functionality but you don't know how to use it? I can do it for you for a reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
24+
Customizations of the library and urgent changes are available upon request for some reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
2825

2926
- [Introduction](https://github.com/alvarotrigo/fullPage.js#introduction)
3027
- [Compatibility](https://github.com/alvarotrigo/fullPage.js#compatibility)
@@ -49,7 +46,7 @@ Would you like to have a website using fullpage.js functionality but you don't k
4946

5047
## Introduction
5148
Suggestion are more than welcome, not only for feature requests but also for coding style improvements.
52-
Let's make this a great plugin to make people's lives easier!
49+
Let's make this a great library to make people's lives easier!
5350

5451
## Compatibility
5552
fullPage.js is fully functional on all modern browsers, as well as some old ones such as Internet Explorer 8, 9, Opera 12, etc.
@@ -90,7 +87,7 @@ npm install fullpage.js
9087
<script src="vendors/jquery.easings.min.js"></script>
9188

9289

93-
<!-- This following line is only necessary in the case of using the plugin option `scrollOverflow:true` -->
90+
<!-- This following line is only necessary in the case of using the option `scrollOverflow:true` -->
9491
<script type="text/javascript" src="vendors/scrolloverflow.min.js"></script>
9592

9693
<script type="text/javascript" src="jquery.fullPage.js"></script>
@@ -132,7 +129,7 @@ In order to create a landscape slider within a section, each slide will be defin
132129
You can see a fully working example of the HTML structure in the [`demoPage.html` file](https://github.com/alvarotrigo/fullPage.js/blob/master/examples/demoPage.html).
133130

134131
###Initialization
135-
All you need to do is call the plugin inside a `$(document).ready` function:
132+
All you need to do is call fullPage.js inside a `$(document).ready` function:
136133

137134
```javascript
138135
$(document).ready(function() {
@@ -198,6 +195,8 @@ $(document).ready(function() {
198195
responsiveWidth: 0,
199196
responsiveHeight: 0,
200197
responsiveSlides: false,
198+
parallax: false,
199+
parallaxOptions: {type: 'reveal', percentage: 62, property: 'translate'},
201200

202201
//Custom selectors
203202
sectionSelector: '.section',
@@ -253,7 +252,7 @@ Note that section anchors can also be defined in the same way, by using the `dat
253252

254253
### Creating smaller or bigger sections
255254
[Demo](http://codepen.io/alvarotrigo/pen/BKjRYm) fullPage.js provides a way to remove the full height restriction from its sections and slides. It is possible to create sections which height is smaller or bigger than the viewport. This is ideal for footers.
256-
It is important to realise that it doesn't make sense to have all of your sections using this feature. If there is more than one section in the initial load of the site, the plugin won't scroll at all to see the next one as it will be already in the viewport.
255+
It is important to realise that it doesn't make sense to have all of your sections using this feature. If there is more than one section in the initial load of the site, fullPage.js won't scroll at all to see the next one as it will be already in the viewport.
257256

258257
To create smaller sections just use the class `fp-auto-height` in the section you want to apply it. It will then take the height defined by your section/slide content.
259258

@@ -273,7 +272,7 @@ Fullpage.js adds multiple classes in different elements to keep a record of the
273272
- A class of the form `fp-viewing-SECTION-SLIDE` is added to the `body` element of the site. (eg: [`fp-viewing-secondPage-0`](http://alvarotrigo.com/fullPage/#secondPage)) The `SECTION` and `SLIDE` parts will be the anchors (or indexes if no anchor is provided) of the current section and slide.
274273
- `fp-responsive` is added to the `body` element when the entering in the responsive mode
275274
- `fp-enabled` is added to the `html` element when fullpage.js is enabled. (and removed when destroyed).
276-
- `fp-destroyed` is added to the fullpage.js container when the plugin is destroyed.
275+
- `fp-destroyed` is added to the fullpage.js container when fullPage.js is destroyed.
277276
- `fp-enabled` is added to the `html` element once the libary is initalized.
278277

279278
###Lazy Loading
@@ -333,7 +332,7 @@ Then you will be able to use and configure them as explained in [options](https:
333332

334333
- `controlArrows`: (default `true`) Determines whether to use control arrows for the slides to move right or left.
335334

336-
- `verticalCentered`: (default `true`) Vertically centering of the content within sections. When set to `true`, your content will be wrapped by the plugin. Consider using delegation or load your other scripts in the `afterRender` callback.
335+
- `verticalCentered`: (default `true`) Vertically centering of the content within sections. When set to `true`, your content will be wrapped by the library. Consider using delegation or load your other scripts in the `afterRender` callback.
337336

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

@@ -348,7 +347,7 @@ $('#fullpage').fullpage({
348347
- `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).
349348
Now anchors can be defined directly in the HTML structure by using the attribute `data-anchor` as explained here.
350349

351-
- `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.
350+
- `lockAnchors`: (default `false`) Determines whether anchors in the URL will have any effect at all in the library. 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.
352351

353352
**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.
354353

@@ -471,6 +470,10 @@ In order to prevent fullpage.js from creating the scrollbar in certain sections
471470

472471
- `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.
473472

473+
- `parallax`: (default `false`) [Extension of fullpage.js](http://alvarotrigo.com/fullPage/extensions/). Defines whether or not to use the parallax backgrounds effects on sections / slides. [Read more about how to apply the parallax option](https://github.com/alvarotrigo/fullPage.js/wiki/Extension---Parallax).
474+
475+
- `parallaxOptions`: (default: `{ type: 'reveal', percentage: 62, property: 'translate'}`). Allows to configure the parameters for the parallax backgrounds effect when using the option parallax:true. [Read more about how to apply the parallax option](https://github.com/alvarotrigo/fullPage.js/wiki/Extension---Parallax).
476+
474477
- `lazyLoading`: (default `true`) Lazy loading is active by default which means it will lazy load any media element containing the attribute `data-src` as detailed in the [Lazy Loading docs](https://github.com/alvarotrigo/fullPage.js#lazy-loading) . If you want to use any other lazy loading library you can disable this fullpage.js feature.
475478

476479
## Methods
@@ -894,7 +897,6 @@ If you want your page to be listed here. Please <a href="mailto:alvaro@alvarotri
894897
- http://promo.prestigio.com/grace1/
895898
- http://www.mi.com/shouhuan
896899
- http://www.commoditiesdemystified.info/en/
897-
- https://moneytree.jp/
898900
- http://torchbrowser.com/
899901
- http://thekorner.fr/
900902
- http://www.restaurantwoods.nl/
@@ -906,10 +908,8 @@ If you want your page to be listed here. Please <a href="mailto:alvaro@alvarotri
906908
- http://thiswasmybest.com/
907909
- http://www.boxreload.com/
908910
- http://lawinenstift.com/
909-
- http://duis.co/
910911
- http://educationaboveall.org/
911912
- http://camfindapp.com/
912-
- http://bnacademy.com.au/
913913
- http://rockercreative.com/
914914
- http://wantnova.com/
915915
- http://usescribe.com/
@@ -922,31 +922,23 @@ If you want your page to be listed here. Please <a href="mailto:alvaro@alvarotri
922922
- http://www.sanyang.com.tw/service/Conception/
923923
- http://www.batzaya.net/
924924
- http://www.graphicid.dk/
925-
- http://portfolio.io.utwente.nl/student/dijkavan/
926925
- http://www.carlphot.com/
927926
- http://medissix.com/
928927
- http://trasmissione-energia.terna.it/
929928
- http://www.thefoodmovie.com/
930929
- http://www.villareginateodolinda.it
931930
- http://www.kesstrio.com
932-
- http://www.karmaffne.com/
933931
- http://fossdistillery.is
934932
- http://www.conversionculture.com/
935933
- http://ded-morozz.kiev.ua/
936-
- http://yizeng.me/
937934
- http://unabridgedsoftware.com/
938-
- http://wc2014.plnwrx.com/
939-
- http://organice.io/
940935
- http://atlanticcorp.us/
941936
- http://moysport.ru/
942-
- http://wcfixtures.co.uk/
943-
- http://www.dopehustleinc.com/default.php
944937
- http://themify.me/demo/#theme=fullpane
945938
- http://dancingroad.com
946939
- http://www.camanihome.com/
947940
- http://www.exapoint.ch/
948941
- https://life2film.com/en/
949-
- http://www.altamirarecovery.com/shame/
950942

951943
You can find another list [here](http://libscore.com/#$.fn.fullpage).
952944

0 commit comments

Comments
 (0)