Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/alvarotrigo/fullPage.js

fullPage plugin by Alvaro Trigo. Create full screen pages fast and simple
https://github.com/alvarotrigo/fullPage.js

fullpage fullscreen javascript jquery mousewheel onepage scrolling sections slide slideshow snap swipe

Last synced: about 1 month ago
JSON representation

fullPage plugin by Alvaro Trigo. Create full screen pages fast and simple

Lists

README 

        
# fullPage.js

![preview](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/intro.png)

![compatibility](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/compatible.png)





  English |

  Español |

  Français |

  Pусский |

  中文 |

  한국어 | 

  Português Brasileiro






	Available for Vue, React and Angular.




---



![fullPage.js version](https://img.shields.io/badge/fullPage.js-v4.0.22-brightgreen.svg)

[![License](https://img.shields.io/badge/License-GPL-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)

[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/alvarotrigo/9.95)

[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/fullpage.js/badge?style=rounded)](https://www.jsdelivr.com/package/npm/fullpage.js)

[![Minzipped Size](https://img.shields.io/bundlephobia/minzip/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)

- [[Migration from fullPage v3 to fullpage v4]](https://alvarotrigo.com/fullPage/help/migration-from-fullpage-3/)

---



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)

  - [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)

- [Callbacks](https://github.com/alvarotrigo/fullPage.js#callbacks)

- [Reporting issues](https://github.com/alvarotrigo/fullPage.js#reporting-issues)

- [Contributing to fullpage.js](https://github.com/alvarotrigo/fullPage.js#contributing-to-fullpagejs)

- [Changelog](https://github.com/alvarotrigo/fullPage.js#changelog)

- [Build tasks](https://github.com/alvarotrigo/fullPage.js#build-tasks)

- [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)

- [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 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.



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.



**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:

 - 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 [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:



Terminal:

```shell

// With bower

bower install fullpage.js



// With npm

npm install fullpage.js

```



### Including files:

```html



```



Using Webpack, Browserify or Require.js? Check how to use fullPage.js with module loaders.



### 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



### Required HTML structure

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 (`
` in this case). The wrapper can not be the `body` element.



```html



	
Some section


	
Some section


	
Some section


	
Some section




```



If you want to define a different starting point rather than the first section or the first slide of a section, just add the class `active` to the section and slide you want to load first.



```html

Some section


```



In order to create a landscape slider within a section, each slide will be defined by default with an element containing the `slide` class:



```html



	
 Slide 1 


	
 Slide 2 


	
 Slide 3 


	
 Slide 4 




```



You can see a fully working example of the HTML structure in the [`simple.html` file](https://github.com/alvarotrigo/fullPage.js/blob/master/examples/simple.html).



### Initialization



#### Initialization with Vanilla Javascript

All you need to do is call fullPage.js before the closing `