Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/openafg/nuxt-fullpage

nuxt-fullpage is a nuxt module for creating fullscreen page scroll fast and simple.
https://github.com/openafg/nuxt-fullpage

fullpage fullpage-scroll nuxt-fullpage nuxt-module nuxtjs vue

Last synced: 2 days ago
JSON representation

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

Awesome Lists containing this project

README

        

### Nuxt fullpage

Nuxt module for creating fullscreen page scroll fast and simple.

- [Demo online](https://codesandbox.io/s/openafgnuxt-fullpage-live-demo-c8qul)

## Table of contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Options](#options)
4. [Contributing](#contributing)

## Installation

Terminal:
```bash
// With npm

npm install --save @openafg/nuxt-fullpage
```

## Usage

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

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

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

```html




First section ...


Second section ...



```

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

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