Skip to content

nuxt-fullpage is a nuxt module for creating fullscreen page scroll fast and simple.

License

Notifications You must be signed in to change notification settings

openafg/nuxt-fullpage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Nuxt fullpage

Nuxt module for creating fullscreen page scroll fast and simple.

Table of contents

  1. Installation
  2. Usage
  3. Options
  4. Contributing

Installation

Terminal:

// With npm

npm install --save @openafg/nuxt-fullpage

Usage

Add @openafg/nuxt-fullpage to the Modules section of nuxt.config.js

export default {
  modules: [
    ['@openafg/nuxt-fullpage', {
      // Options
    }]
  ]
}

Required HTML

This wrapper creates a <full-page> component, which you can use like other Vue.js components. For example:

<div>
    <full-page>
      <section class="section">
        First section ...
      </section>
      <section class="section">
        Second section ...
      </section>
  </full-page>
</div>

Options

To configure the module, in nuxt.config.js.

export default {
  modules: [
    ['@openafg/nuxt-fullpage', {
      activeSection: 0,
      mouseWheelSensitivity: 120,
      showIndicators: false
    }]
  ]
}

Contributing