nanime

This module provides a set of SSR safe composables and components to make it easier to use AnimeJS in your Nuxt application.

• ✨  Release Notes
• 📖  Documentation

Features

• Help to integrate animejs into your project without the need for much boilerplate codes
• SSR Safe components like useAnimate, useWaapiAnimate, ..etc
• Provides a set of transition components created with the waapi utility
• Doesn't include predefined animation settings other than animejs defaults
• Zero-config setup needed

Quick Setup

Installation with nuxt module command

Install the module to your Nuxt application with one command:

npx nuxt module add nanime

Manual install

npm install nanime

Then add the module to the modules section of your nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['nanime'],
  nanime: { ... },
})

That's it! You can now use the module in your application

Contribution

# 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