Getting Started

Welcome Wizzards! ๐Ÿง™โ€โ™‚๏ธ
This is a Nuxt Module for a easy Plugin & Play to create some outstanding Animation with Anime.js v4.
So let's not waste any time and get started right away. Your story starts here.

We are currently engaged in significant feature development, which may result in frequent updates to the project. We encourage you to regularly check for the latest releases to experience the newest functionalities. So check out the latest npm Version.

1. Installation

Yarn
yarn add nuxt-anime
NPM
npm install nuxt-anime
Bun
bun add nuxt-anime

2. Add the Module to your Nuxt config

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ["nuxt-anime"]
});

3. Ready - Test it out.

You are now ready to test it the Composables. Currently we provide useAnimate and useAnimateTimeline. More helper and functionalities are planned.

<script lang="ts" setup>
const box = useTemplateRef("box");
const anim = await useAnimate(box, {
  autoplay: false,
  x: 100,
  rotate: 360,
});
</script>
Loading Sandbox...

You can start playing with Nuxt-Anime Playground in your browser using Stackblitz:

Play on StackBlitz