48.1K
aos

aos

A Nuxt module that adds Animate On Scroll

599 downloads
23 stars
egidiusmengelbergegidiusmengelberg

Nuxt Aos

npm versionnpm downloadsLicenseNuxt

A Nuxt module for adding animate on scroll to your application.

Features

  • ⛰  Easily add animate on scroll library to your nuxt app

Quick Setup

  1. Add nuxt-aos dependency to your project
# Using pnpmpnpm add -D nuxt-aos# Using yarnyarn add --dev nuxt-aos# Using npmnpm install --save-dev nuxt-aos
  1. Add nuxt-aos to the modules section of nuxt.config.ts
export default defineNuxtConfig({  modules: [    'nuxt-aos'  ]})

That's it! You can now use Aos in your Nuxt app on every page ✨

For example:

<div data-aos="fade-up"></div>

Development

# Install dependenciesnpm install# Generate type stubsnpm run dev:prepare# Develop with the playgroundnpm run dev# Build the playgroundnpm run dev:build# Run ESLintnpm run lint# Run Vitestnpm run testnpm run test:watch# Release new versionnpm run release