Ecosyste.ms: Awesome

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

https://github.com/alvarotrigo/vue-fullpage.js

Official Vue.js wrapper for fullPage.js http://alvarotrigo.com/vue-fullpage/
https://github.com/alvarotrigo/vue-fullpage.js

fullpage fullpagejs fullscreen javascript mousewheel onepage scrolling slideshow snap vue vue-components vue-wrapper vuejs

Last synced: about 1 month ago
JSON representation

Official Vue.js wrapper for fullPage.js http://alvarotrigo.com/vue-fullpage/

Lists

README 

        
# Vue-fullpage.js - Official Vue.js 3 wrapper



![preview](https://alvarotrigo.com/fullPage/vue-fullpage/imgs/vue-fullpage-wrapper.png)





Official Vue.js 3 wrapper for the fullpage.js library.






  

    vue-fullpage.js version

  




- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)

- By [@imac2](https://twitter.com/imac2). Thanks to [VasiliyGryaznoy](https://github.com/VasiliyGryaznoy) , [dragg](https://github.com/dragg), [Raphael Owino](https://twitter.com/ralphowino) and [Jonathan Schneider](https://github.com/JonathanSchndr/).



## Table of contents



- [Vue-fullpage.js - Official Vue.js 3 wrapper](#vue-fullpagejs---official-vuejs-3-wrapper)

  - [Table of contents](#table-of-contents)

  - [Installation](#installation)

  - [License](#license)

    - [Commercial license](#commercial-license)

    - [Open source license](#open-source-license)

  - [Example](#example)

  - [Usage](#usage)

    - [Bundler (Vite)](#bundler-vite)

    - [Browser](#browser)

  - [Required HTML](#required-html)

  - [Options](#options)

    - [Delayed init](#delayed-init)

  - [Methods](#methods)

  - [Callbacks](#callbacks)

  - [Dynamic changes](#dynamic-changes)

  - [Usage with Nuxt.js](#usage-with-nuxtjs)

  - [:construction: Usage with Gridsome](#construction-usage-with-gridsome)

  - [Contributing](#contributing)

- [Resources](#resources)



## Installation



Terminal:



```bash

// With npm

npm install --save vue-fullpage.js

```



## License



### Commercial license

If you want to use fullPage to develop nonopen sourced sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. This 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/).



## Example



```bash

// With npm

cd example/

npm install

npm run start

```



## Usage



### Bundler (Vite)



```js

import { createApp } from 'vue'

import App from './App.vue'



import 'vue-fullpage.js/dist/style.css'

import './fullpage.scrollHorizontally.min' // Optional. When using fullpage extensions

import VueFullPage from 'vue-fullpage.js'



const app = createApp(App)

app.use(VueFullPage)

app.mount('#app')

```



Notice that when using the option `scrollOverflow:true` or any [fullPage.js extension](https://alvarotrigo.com/fullPage/extensions/) you'll have to include the file for those features before the `vue-fullpage` component.



### Browser



You can check a browser stand-alone demo [here](https://github.com/alvarotrigo/vue-fullpage.js/tree/master/demos/stand-alone/).



```html



```



## Required HTML



This wrapper creates a `` component , which you can use like other Vue.js components. For example:



```html



  

    
First section ...


    
Second section ...


  



```



## Options



You can use any [options](https://github.com/alvarotrigo/fullPage.js#options) supported by fullPage.js library.

Just pass the options object into this wrapper like Vue.js property.

Options object can contain simple [options](https://github.com/alvarotrigo/fullPage.js#options) as well as fullPage.js [callbacks](https://github.com/alvarotrigo/fullPage.js#callbacks).



Notice that if you want to make use of the option `scrollOverflow:true`, you'll have to include the scrollOverflow file before vue-fullpage.js, as detailed [above](https://github.com/alvarotrigo/vue-fullpage.js#bundler-webpack-rollup).



Example:



```javascript

export default {

  data() {

    return {

      options: {

        licenseKey: 'YOUR_KEY_HERE',

        menu: '#menu',

        anchors: ['page1', 'page2', 'page3'],

        sectionsColor: ['#41b883', '#ff5f45', '#0798ec'],

      },

    }

  }

}

```



### Delayed init



Full-page will init itself automatically on `mount`. This may not work properly when using async components inside its sections, as it has no way of knowing when said components are ready and mounted.



Use the `skipInit` prop to stop full-page from initializing itself. You can do it when youself by using a `ref` like:



```html



```



```js

methods: {

  // Called when your components are ready. That is up to you to decide when.

  componentsReady() {

    this.$refs.fullpage.init()

  }

}

```



## Methods



You can make use of any of the [methods](https://github.com/alvarotrigo/fullPage.js#methods) provided by fullPage.js by accessing the instance object via the reference `$refs.fullpage.api`.



Example:



```html



  


    

      


        

          Next

        

        Section 1

      


      


        

          Prev

        

        Section 2

      


    

  



```



Similar you can call any method of fullPage.js library directly on Javascript:



```javascript

fullpage_api.setAllowScrolling(false)

```



## Callbacks



As mentioned [above](#options) you can pass callbacks through options object:



```html



  


    

      
First section ...


      
Second section ...


    

  



  export default {

    data() {

      return {

        options: {

          afterLoad: this.afterLoad,

        },

      }

    },



    methods: {

      afterLoad() {

        console.log("Emitted 'after load' event.")

      },

    },

  }



```



Or you can use the standard approach for event handling of Vue.js:



```html



  


     .... 

  



  export default {

      methods: {

        afterLoad() {

          ...

        }

      }

    }



```



Similarly, you can handle any [event](https://github.com/alvarotrigo/fullPage.js#callbacks) of the fullPage.js library.

Just translate camelCase name of callback to kebab-case and use it ;)



## Dynamic changes



vue-fullpage.js will watch all changes taking place within the fullpage.js options but will NOT automatically watch any DOM changes. If you want vue-fullpage.js to react to DOM changes call the `build()` method after making those changes. For example:



```javascript

//creating the section div

var section = document.createElement('div')

section.className = 'section'

section.innerHTML = '
New Section
'



//adding section

document.querySelector('#fullpage').appendChild(section)



//where --> var vm = new Vue({...}) if calling it from outside.

vm.$refs.fullpage.build()



//or, when calling it from inside the Vue component methods:

this.$refs.fullpage.build()

```



In order for fullPage.js to get updated after a change in any of the fullPage.js options, you'll have to make sure to use such an option in the initialization.



For example, if we want fullPage.js to get updated whenever I change the `scrollBar` and `controlArrows` options, I'll have to use the following initialisation:



```js

export default {

  data() {

    return {

      options: {

        licenseKey: 'YOUR_KEY_HERE',

        controlArrows: true,

        scrollBar: true,

      },

    }

  },

}

```



## Usage with Nuxt.js



Use the [nuxt-fullpage](https://github.com/alvarotrigo/nuxt-fullpage) module in order to use Nuxt with vue-fullpage.js.



## :construction: Usage with Gridsome



TBD



## Contributing



Please see [Contributing to fullpage.js](https://github.com/alvarotrigo/fullPage.js/wiki/Contributing-to-fullpage.js)



# Resources



- [Wordpress theme](https://alvarotrigo.com/fullPage/utils/wordpress.html)

- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)

- [WordPress Plugin for Elementor](https://alvarotrigo.com/fullPage/wordpress-plugin-elementor/)

- [WordPress Plugin for Gutenberg](https://alvarotrigo.com/fullPage/wordpress-plugin-gutenberg/)

- [CSS Easing Animation Tool - Matthew Lein](http://matthewlein.com/ceaser/) (useful to define the `easingcss3` value)

- [fullPage.js cdnJS CDN](https://cdnjs.com/libraries/fullPage.js)



[npm-version-src]: https://img.shields.io/npm/v/vue-fullpage.js/latest.svg

[npm-version-href]: https://www.npmjs.com/package/vue-fullpage.js