\n\n- [Codesandbox Demo](https://codesandbox.io/p/devbox/t6fzdr?file=%2Findex.html)\n- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)\n- 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/).\n\n## Table of contents\n\n- [Vue-fullpage.js - Official Vue.js 3 wrapper](#vue-fullpagejs---official-vuejs-3-wrapper)\n - [Table of contents](#table-of-contents)\n - [Installation](#installation)\n - [License](#license)\n - [Commercial license](#commercial-license)\n - [Open source license](#open-source-license)\n - [Example](#example)\n - [Usage](#usage)\n - [Bundler (Vite)](#bundler-vite)\n - [Browser](#browser)\n - [Required HTML](#required-html)\n - [Options](#options)\n - [Delayed init](#delayed-init)\n - [Methods](#methods)\n - [Callbacks](#callbacks)\n - [Dynamic changes](#dynamic-changes)\n - [Usage with Nuxt.js](#usage-with-nuxtjs)\n - [:construction: Usage with Gridsome](#construction-usage-with-gridsome)\n - [Automation](#automation)\n - [Contributing](#contributing)\n- [Resources](#resources)\n\n## Installation\n\nTerminal:\n\n```bash\n// With npm\nnpm install --save vue-fullpage.js\n```\n\n## License\n\n### Commercial license\nIf 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/)\n\n### Open source license\nIf 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.\n\n**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).\n\n[Read more about fullPage's license](https://alvarotrigo.com/fullPage/pricing/).\n\n## Example\n\n```bash\n// With npm\ncd example/\nnpm install\nnpm run start\n```\n\n## Usage\n\n### Bundler (Vite)\n\n```js\nimport { createApp } from 'vue'\nimport App from './App.vue'\n\nimport 'vue-fullpage.js/dist/style.css'\nimport './fullpage.scrollHorizontally.min' // Optional. When using fullpage extensions\nimport VueFullPage from 'vue-fullpage.js'\n\nconst app = createApp(App)\napp.use(VueFullPage)\napp.mount('#app')\n```\n\nNotice 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.\n\n### Browser\n\nYou can check a browser stand-alone demo [here](https://github.com/alvarotrigo/vue-fullpage.js/tree/master/demos/stand-alone/).\n\n```html\n\n\n\n\n\n```\n\n## Required HTML\n\nThis wrapper creates a `` component , which you can use like other Vue.js components. For example:\n\n```html\n
\n \n
First section ...
\n
Second section ...
\n \n
\n```\n\n## Options\n\nYou can use any [options](https://github.com/alvarotrigo/fullPage.js#options) supported by fullPage.js library.\nJust pass the options object into this wrapper like Vue.js property.\nOptions 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).\n\nNotice 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).\n\nExample:\n\n```javascript\nexport default {\n data() {\n return {\n options: {\n licenseKey: 'YOUR_KEY_HERE',\n menu: '#menu',\n anchors: ['page1', 'page2', 'page3'],\n sectionsColor: ['#41b883', '#ff5f45', '#0798ec'],\n },\n }\n }\n}\n```\n\n### Delayed init\n\nFull-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.\n\nUse the `skipInit` prop to stop full-page from initializing itself. You can do it when youself by using a `ref` like:\n\n```html\n\n```\n\n```js\nmethods: {\n // Called when your components are ready. That is up to you to decide when.\n componentsReady() {\n this.$refs.fullpage.init()\n }\n}\n```\n\n## Methods\n\nYou 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`.\n\nExample:\n\n```html\n\n
\n \n
\n \n Section 1\n
\n
\n \n Section 2\n
\n \n
\n\n```\n\nSimilar you can call any method of fullPage.js library directly on Javascript:\n\n```javascript\nfullpage_api.setAllowScrolling(false)\n```\n\n## Callbacks\n\nAs mentioned [above](#options) you can pass callbacks through options object:\n\n```html\n\n
\n \n
First section ...
\n
Second section ...
\n \n
\n\n\n\n```\n\nOr you can use the standard approach for event handling of Vue.js:\n\n```html\n\n
\n .... \n
\n\n\n```\n\nSimilarly, you can handle any [event](https://github.com/alvarotrigo/fullPage.js#callbacks) of the fullPage.js library.\nJust translate camelCase name of callback to kebab-case and use it ;)\n\n## Dynamic changes\n\nvue-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:\n\n```javascript\n//creating the section div\nvar section = document.createElement('div')\nsection.className = 'section'\nsection.innerHTML = '
New Section
'\n\n//adding section\ndocument.querySelector('#fullpage').appendChild(section)\n\n//where --> var vm = new Vue({...}) if calling it from outside.\nvm.$refs.fullpage.build()\n\n//or, when calling it from inside the Vue component methods:\nthis.$refs.fullpage.build()\n```\n\nIn 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.\n\nFor 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:\n\n```js\nexport default {\n data() {\n return {\n options: {\n licenseKey: 'YOUR_KEY_HERE',\n controlArrows: true,\n scrollBar: true,\n },\n }\n },\n}\n```\n\n## Usage with Nuxt.js\n\nUse the [nuxt-fullpage](https://github.com/alvarotrigo/nuxt-fullpage) module in order to use Nuxt with vue-fullpage.js.\n\n## :construction: Usage with Gridsome\n\nTBD\n\n## Automation\n\nThis repository includes automated GitHub Actions for keeping fullPage.js up-to-date. See [`.github/WORKFLOWS.md`](.github/WORKFLOWS.md) for detailed documentation.\n\n## Contributing\n\nPlease see [Contributing to fullpage.js](https://github.com/alvarotrigo/fullPage.js/wiki/Contributing-to-fullpage.js)\n\n# Resources\n\n- [Wordpress theme](https://alvarotrigo.com/fullPage/utils/wordpress.html)\n- [fullpage.js Extensions](https://alvarotrigo.com/fullPage/extensions/)\n- [WordPress Plugin for Elementor](https://alvarotrigo.com/fullPage/wordpress-plugin-elementor/)\n- [WordPress Plugin for Gutenberg](https://alvarotrigo.com/fullPage/wordpress-plugin-gutenberg/)\n- [CSS Easing Animation Tool - Matthew Lein](http://matthewlein.com/ceaser/) (useful to define the `easingcss3` value)\n- [fullPage.js cdnJS CDN](https://cdnjs.com/libraries/fullPage.js)\n\n\n\n\n[npm-version-src]: https://img.shields.io/npm/v/vue-fullpage.js/latest.svg\n[npm-version-href]: https://www.npmjs.com/package/vue-fullpage.js\n","readmeFilename":"README.md"}
![\"vue-fullpage.js](\"https://img.shields.io/npm/v/vue-fullpage.js/latest.svg\")
\n \n