@openafg/nuxt-fullpage

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

Showing:

Popularity

Downloads/wk

20

GitHub Stars

8

Maintenance

Last Commit

3mos ago

Contributors

0

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100