Nuxt module for animejs integration and transitions
npm install nanime[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![release nanime][release-src]][release-href]
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
- 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
Install the module to your Nuxt application with one command:
``bash`
npx nuxt module add nanime
`bash`
npm install nanime
Then add the module to the modules section of your nuxt.config.ts:
`ts`
export default defineNuxtConfig({
modules: ['nanime'],
nanime: { ... },
})
That's it! You can now use the module in your application
Local development
`bash``
# 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
[npm-version-src]: https://img.shields.io/npm/v/nanime/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nanime
[npm-downloads-src]: https://img.shields.io/npm/dm/nanime.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npm.chart.dev/nanime
[license-src]: https://img.shields.io/npm/l/nanime.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nanime
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt
[nuxt-href]: https://nuxt.com
[release-src]: https://github.com/astraldev/nanime/actions/workflows/npm-publish.yml/badge.svg
[release-href]: https://github.com/astraldev/nanime/actions/workflows/npm-publish.yml