Getting Started

Installation

Install the module to your Nuxt application with one command:

npx nuxi module add @vikeriait/nuxt-viewport

Configuration

Add the module to your nuxt.config.ts. For detailed configuration options, please refer to the Core Library Documentation.

export default defineNuxtConfig({
  modules: ['@vikeriait/nuxt-viewport'],
  viewport: {
    // Options here
  }
})

Usage

The module exposes the functionality of @vikeriait/vue-viewport. For detailed API documentation, configuration options, and advanced usage, please refer to the Core Library Documentation.

Directive

<template>
  <div v-viewport:slide-up>
    I will animate when I enter the viewport!
  </div>
</template>

Composable

<script setup>
const { isInView } = useViewport()
</script>