# NuxtAnime
[![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]
[![Volta][volta-src]][volta-href]
[![Anime][anime-src]][anime-href]
A Plug & Play Adapter for the new Anime.js 4 Version.
- [⨠Release Notes](/CHANGELOG.md)
- [đ Online playground](https://stackblitz.com/github/Enternikot/NuxtAnime/tree/master/playground?file=package.json)
- [đ Documentation](https://nuxtanime.vercel.app/)
## Features
- ⨠**Zero Configuration**: No setup required to get started.
- đĒ **Flexible Usage**: Choose your style â use as **Composables**, **Directives**, or **Components**.
- đˇ **Core Features**: Currently supports `animate` and `timeline`. More functions and helpers are planned!
- đˇ **Type-Safe**: Full TypeScript support for current Anime.js v4 parameters.
- 𧊠**Easy & Customizable**: Simple to integrate and fully adaptable to your needs.
- đšī¸ **Full Control**: Provides complete access to the `JSAnimation` object and methods returned by Anime.js for fine-grained control.
## Quick Setup
Install the Module manually with:
```bash
npm install nuxt-anime
```
Then, add it to your `modules` in your `nuxt.config`
```js
export default defineNuxtConfig({
modules: ["nuxt-anime"],
});
```
That's it! You can now use NuxtAnime in your Nuxt app â¨
```js
```
## Contribution
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
```
## đ License
Published under the [MIT License](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/nuxt-anime/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nuxt-anime
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-anime.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npm.chart.dev/nuxt-anime
[license-src]: https://img.shields.io/npm/l/nuxt-anime.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nuxt-anime
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com
[anime-src]: https://img.shields.io/badge/Anime.js-020420
[anime-href]: https://animejs.com/
[volta-src]: https://img.shields.io/badge/Open%20Board-020420?logo=volta
[volta-href]: https://volta.net/Enternikot/NuxtAnime