aos

Go to documentation

A Nuxt module that adds Animate On Scroll

1 maintainer

459 installs

3 stars

Nuxt Aos

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

✨ Release Notes

Features

⛰ Easily add animate on scroll library to your nuxt app

Quick Setup

Add nuxt-aos dependency to your project

# Using pnpm
pnpm add -D nuxt-aos

# Using yarn
yarn add --dev nuxt-aos

# Using npm
npm install --save-dev nuxt-aos

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 dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release