Skip to content

Official Nuxt Module For The Official vue-fullpage wrapper

License

Notifications You must be signed in to change notification settings

alvarotrigo/nuxt-fullpage

Repository files navigation

Vue-fullpage.js - Official Nuxt 3 Module

Official Nuxt 3 Module for the fullpage.js library.

npm version

Table of contents

Installation

  1. Add @fullpage/nuxt-fullpage dependency to your project
npm install @fullpage/nuxt-fullpage
  1. Add @fullpage/nuxt-fullpage to the modules section of nuxt.config.js
// nuxt.config.js
{
  modules: [
    '@fullpage/nuxt-fullpage'
  ]
}

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]

Open source license

If you are creating an open-source application under a license compatible with the GNU GPL license v3, 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.

Example

  • Run npm run dev:prepare to generate type stubs.
  • Use npm run dev to start playground in development mode.

Usage

Take a look at the usage of the official Vue wrapper.

Contributing

Please see Contributing to fullpage.js

Resources