diff --git a/. jshintrc b/. jshintrc new file mode 100644 index 000000000..5764f7399 --- /dev/null +++ b/. jshintrc @@ -0,0 +1,3 @@ +{ + "esversion": 6, +} \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 86b458d96..58f279ac5 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,7 @@ ### Description ### Link to isolated reproduction with no external CSS / JS -[Ideally in jsfiddle.net or codepen.io, links to personal websites won't be reviewed unless isolated. Reported issues without a reproduction might get closed.] +[Ideally in jsfiddle.net (https://jsfiddle.net/alvarotrigo/ea17skjr) or codepen.io (https://codepen.io/alvarotrigo/pen/qqabrp), links to personal websites won't be reviewed unless isolated. Reported issues without a reproduction might get closed.] ### Steps to reproduce it 1. [First step] @@ -9,4 +9,4 @@ 3. [and so on...] ### Versions -[Browser, operative system, device...] \ No newline at end of file +[Browser, operating system, device, ...] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6f7e65ffe..ad570f2ca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,2 +1,2 @@ -1- Make sure to commit it to the `dev` branch! -2- Read https://github.com/alvarotrigo/fullPage.js/wiki/Contributing-to-fullpage.js \ No newline at end of file +1. Make sure to commit it to the `dev` branch! +2. Read https://github.com/alvarotrigo/fullPage.js/wiki/Contributing-to-fullpage.js diff --git a/.gitignore b/.gitignore index c6d3a6717..6cf793bd1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,24 @@ .DS_Store .idea +.ignore/ +.vscode/* +.history/ bower_components/ -/node_modules +node_modules/ +**/node_modules/ +package-lock.json +src/fullpage.extensions.js +src/js-extensions/** +src/js-limited/** +src/css-limited/** +src/js/mixed/index.js +dist/fullpage.extensions.js +dist/fullpage.limited.js +dist/fullpage.limited.min.js +dist/fullpage.limited.min.css +examples/bug** +gulp/secret.js +build/** +local/** +rollup.ext.config.js +rollup.limited.config.js \ No newline at end of file diff --git a/BACKERS.md b/BACKERS.md new file mode 100644 index 000000000..53fcd29c2 --- /dev/null +++ b/BACKERS.md @@ -0,0 +1,41 @@ +# Sponsors & Backers + +fullPage.js is being developed and maintained by [Alvaro Trigo](https://twitter.com/imac2). +Any help you can provide for its development and maintenance over time will be appreciated! + +Here's the list of the persons/companies which are currently contributing to fullPage.js. +Thanks for it! + +Want to be in the list? [Contact me](https://alvarotrigo.com/#contact) | [Become a patreon](https://www.patreon.com/fullpagejs) + +## Bronze Sponsor ($30+ / month) + +### Companies + +
+
+ ![]() |
+
+
+ ![]() |
+
+
+ ![]() |
+
+
+ ![]() |
+
-
+ English |
+ Español |
+ Français |
+ Pусский |
+ 中文 |
+ 한국어 |
+ 日本語 |
+ Português Brasileiro
+
+ Available for Vue, React and Angular.
--- - -[](http://opensource.org/licenses/MIT) + +[](https://www.gnu.org/licenses/gpl-3.0.html) [](https://www.paypal.me/alvarotrigo/9.95) - **|** *7Kb gziped* **|** *Created by [@imac2](https://twitter.com/imac2)* - -- [Live demo](http://alvarotrigo.com/fullPage/) -- [Wordpress theme](http://alvarotrigo.com/fullPage/utils/wordpress-y-theme.html) -- [fullpage.js Extensions](http://alvarotrigo.com/fullPage/extensions/) +[](https://www.jsdelivr.com/package/npm/fullpage.js) +[](https://bundlephobia.com/package/fullpage.js) + **|** *Created by [@imac2](https://twitter.com/imac2)* + +- [Demo online](https://alvarotrigo.com/fullPage/) | [Codepen](https://codepen.io/alvarotrigo/pen/qqabrp) +- [Wordpress plugin for Gutenberg](https://alvarotrigo.com/fullPage/wordpress-plugin-gutenberg/) and [WordPress plugin for Elementor](https://alvarotrigo.com/fullPage/wordpress-plugin-elementor/) +- [Wordpress theme](https://alvarotrigo.com/fullPage/utils/wordpress.html) +- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/) - [Frequently Answered Questions](https://github.com/alvarotrigo/fullPage.js/wiki/FAQ---Frequently-Answered-Questions) - -[](http://alvarotrigo.com/fullPage/utils/wordpress-y-theme.html) - +- [[Migration from fullPage v3 to fullpage v4]](https://alvarotrigo.com/fullPage/help/migration-from-fullpage-3/) --- -A simple and easy to use libary to create fullscreen scrolling websites (also known as single page websites or onepage sites). -It allows the creation of fullscreen scrolling websites, as well as adding some landscape sliders inside the sections of the site. - -Invite me to a coffee -[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=fullPage%2ejs¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted) - -Customizations of the library and urgent changes are available upon request for some reasonable price. Contact me. +A simple and easy to use library that creates fullscreen scrolling websites (also known as single page websites or onepage sites) and adds landscape sliders inside the sections of the site. - [Introduction](https://github.com/alvarotrigo/fullPage.js#introduction) - [Compatibility](https://github.com/alvarotrigo/fullPage.js#compatibility) +- [License](https://github.com/alvarotrigo/fullPage.js#license) - [Usage](https://github.com/alvarotrigo/fullPage.js#usage) - [Creating links to sections or slides](https://github.com/alvarotrigo/fullPage.js#creating-links-to-sections-or-slides) - [Creating smaller or bigger sections](https://github.com/alvarotrigo/fullPage.js#creating-smaller-or-bigger-sections) - [State classes added by fullpage.js](https://github.com/alvarotrigo/fullPage.js#state-classes-added-by-fullpagejs) - [Lazy loading](https://github.com/alvarotrigo/fullPage.js#lazy-loading) - - [Autoplay embedded media](https://github.com/alvarotrigo/fullPage.js#auto-playpause-embedded-media) + - [Auto play/pause embedded media](https://github.com/alvarotrigo/fullPage.js#auto-playpause-embedded-media) - [Use extensions](https://github.com/alvarotrigo/fullPage.js#use-extensions) - [Options](https://github.com/alvarotrigo/fullPage.js#options) - [Methods](https://github.com/alvarotrigo/fullPage.js#methods) @@ -49,28 +56,36 @@ Customizations of the library and urgent changes are available upon request for - [Resources](https://github.com/alvarotrigo/fullPage.js#resources) - [Who is using fullpage.js](https://github.com/alvarotrigo/fullPage.js#who-is-using-fullpagejs) - [Donations](https://github.com/alvarotrigo/fullPage.js#donations) -- [License](https://github.com/alvarotrigo/fullPage.js#license) +- [Sponsors](https://github.com/alvarotrigo/fullPage.js#sponsors) ## Introduction Suggestion are more than welcome, not only for feature requests but also for coding style improvements. Let's make this a great library to make people's lives easier! ## Compatibility -fullPage.js is fully functional on all modern browsers, as well as some old ones such as Internet Explorer 8, 9, Opera 12, etc. -It works with browsers with CSS3 support and with the ones which don't have it, making it ideal for old browsers compatibility. +fullPage.js is fully functional on all modern browsers and with IE 11. If you need to support IE < 11 consider using [fullPage.js v3](https://github.com/alvarotrigo/fullPage.js/tree/3.1.2). It also provides touch support for mobile phones, tablets and touch screen computers. -[](http://www.browserstack.com/) +Special thanks to [Browserstack](https://www.browserstack.com/) for supporting fullpage.js. + +## License + +### Commercial license +If you want to use fullPage to develop non open sourced sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Which means, you won't have to change your whole application source code to an open source license. [[Purchase a Fullpage Commercial License]](https://alvarotrigo.com/fullPage/pricing/) + +### Open source license +If you are creating an open source application under a license compatible with the [GNU GPL license v3](https://www.gnu.org/licenses/gpl-3.0.html), you may use fullPage under the terms of the GPLv3. -Special thanks to [Browserstack](http://www.browserstack.com/) for supporting fullpage.js. +**You will have to provide a prominent notice that fullPage.js is in use. The credit comments in the JavaScript and CSS files should be kept intact** (even after combination or minification). + +[Read more about fullPage's license](https://alvarotrigo.com/fullPage/pricing/). ## Usage As you can see in the example files, you will need to include: - - [jQuery library](http://jquery.com/). (1.6.0 minimum) - - The JavaScript file `jquery.fullPage.js` (or its minified version `jquery.fullPage.min.js`) - - The css file `jquery.fullPage.css` + - The JavaScript file `fullpage.js` (or its minified version `fullpage.min.js`) + - The css file `fullpage.css` - **Optionally**, when using `css3:false`, 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 (`linear` and `swing` ) or the one included by default in fullPage.js (`easeInOutCubic`). + **Optionally**, when using `css3:false`, you can add the [easings file](https://github.com/alvarotrigo/fullPage.js/tree/master/vendors/easings.min.js) in case you want to use other easing effects apart from the one included in the library (`easeInOutCubic`). ### Install using bower or npm **Optionally**, you can install fullPage.js with bower or npm if you prefer: @@ -84,33 +99,29 @@ bower install fullpage.js npm install fullpage.js ``` -### Including files: +### Including files ```html - - - - - - + + + - - - - + ``` +Using Webpack, Browserify or Require.js? Check [how to use fullPage.js with module loaders](https://github.com/alvarotrigo/fullPage.js/wiki/Use-module-loaders-for-fullPage.js). + ### Optional use of CDN -If you prefer to use a CDN to load the needed files, fullPage.js is in CDNJS: -https://cdnjs.com/libraries/fullPage.js +If you prefer to use a CDN to load the needed files, fullPage.js is in, [JSDelivr](https://www.jsdelivr.com/package/npm/fullpage.js), [UNPKG](https://unpkg.com/browse/fullpage.js/dist/), [CDNJS](https://cdnjs.com/libraries/fullPage.js) and others. ### Required HTML structure -Start your HTML document with the compulsory [HTML DOCTYPE declaration](http://www.corelangs.com/html/introduction/doctype.html) on the 1st line of your HTML code. You might have troubles with sections heights otherwise. The examples provided use HTML 5 doctype ``. +Start your HTML document with the compulsory [HTML DOCTYPE declaration](https://www.corelangs.com/html/introduction/doctype.html) on the 1st line of your HTML code. You might have troubles with sections heights otherwise. The examples provided use HTML 5 doctype ``. Each section will be defined with an element containing the `section` class. The active section by default will be the first section, which is taken as the home page. Sections should be placed inside a wrapper (`