Index of every page on this site: llms.txt
All skills
onmax avatar

/nanime

@b4e1a3f official
by Maxonmax/nuxt-skills729 stars
38
Run it yourself

Build animations in a Nuxt app with nanime, the Nuxt module wrapping Anime.js v4. Use when animating elements, text, SVG or scroll in Nuxt: useAnimate, useWaapiAnimate, useAnimatable, useAnimeTimeline, useDraggable, useSplitText, useScrambleText, useAnimeScroll, useAnimeLayout, <AnimeTransition>, <AnimeTransitionGroup>, <AnimeLayoutGroup>, transition styles, component defaults, provideAnimeDefaults and the #nanime/* aliases. Also use when an effect seems to need raw animejs, GSAP or CSS transition classes. Most mistakes here do not throw; they animate the wrong thing.

Use this Skill: https://skilld.dev/gh/onmax/nuxt-skills/nanime

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈146 tokens for metadata: the name and description. ≈1.8k when used: this file. ≈4.5k more on demand in 5 files.

Description uses 7.3% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈583 characters, or 7.3%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

nanime

The composables own an Anime.js instance, rebuild it when reactive inputs change, and revert it on unmount. They wait for mount, so they are SSR-safe. Composables and components are auto-imported and auto-registered.

Don't drop to onMounted with raw animejs imports, and don't reach for GSAP or transition CSS. The effect almost always has a nanime path.

Pick the tool

Building Use Details
Animating elements, refs, arrays, plain objects useAnimate (useWaapiAnimate for the Web Animations API)
Values set imperatively at speed (cursor follow, live counter) useAnimatable
Sequencing useAnimeTimeline timelines.md
Scroll-driven animation useAnimeScroll timelines.md
Text split into lines, words, chars useSplitText timelines.md
Scrambling or revealing text useScrambleText
SVG draw, morph, motion path #nanime/proxies/svg inside a composable timelines.md
Dragging with snap, bounds, axis locks useDraggable lists.md for draggable list items
v-if / v-show / keyed enter and leave, crossfades <AnimeTransition> transitions.md
v-for add, remove, reorder, stagger <AnimeTransitionGroup> transitions.md, lists.md
Mounted elements changing position or size (FLIP) <AnimeLayoutGroup>, or useAnimeLayout to await it layout.md
Testing an animation without a browser verifying.md

For an Anime.js parameter, return shape or util, read https://animejs.com/documentation. nanime passes those through unchanged. For nanime's own API, read https://nanimejs.netlify.app/llms-full.txt or query the docs MCP server at https://nanimejs.netlify.app/mcp.

Aliases

Not auto-imported. Import helpers from these, never from animejs directly.

Alias Holds
#nanime/types Anime.js types (AnimationParams, JSAnimation, …) and AnimeTransitionStyle
#nanime/utils Anime.js utils (stagger, random, set, …), plus animate and createTimer for handler code
#nanime/easings spring, cubicBezier, steps, …
#nanime/proxies/svg createMotionPath, createDrawable, morphTo
#nanime/proxies/text scrambleText, for use inside animation parameters
#nanime/proxies Both of the above

Rules

Each of these fails without an error.

Parameters that read a template ref must be a getter

useAnimeScroll(() => ({ target: section.value ?? undefined }))   // correct
useAnimeScroll({ target: section.value })                        // silently wrong

A template ref is null during setup. A plain object is read once, then, so Anime.js falls back to a default, such as watching document.body instead of your element. A getter is read again once the element exists.

Read .value yourself: Anime.js does not unwrap Vue refs inside parameters. Template refs are T | null while most params take T | undefined, so use ?? undefined, not a cast.

Call composables only in setup

function onClick() {
  useAnimate(box, { x: 100 })   // leaks: no effect scope, never reverted
}

From a handler or per-frame callback, use animate from #nanime/utils and own the handle:

import { animate } from '#nanime/utils'
import type { JSAnimation } from '#nanime/types'

const pulse = shallowRef<JSAnimation | null>(null)
onScopeDispose(() => pulse.value?.revert())

function highlight(el: HTMLElement) {
  pulse.value?.revert()
  pulse.value = animate(el, { scale: [1, 1.1, 1], duration: 400 })
}

Code of your own that reads an element must also wait for mount.

Pass composable returns straight in

nanime unwraps a composable's return value to its Anime.js instance, in parameters and in a timeline's sync():

const scroll = useAnimeScroll(() => ({ target: section.value ?? undefined, sync: true }))
useAnimate(box, { x: 400, autoplay: scroll })

One scroll observer drives one animation. Handing it to a second animation steals it from the first, which freezes. Call useAnimeScroll once per animation; observers with the same params stay in step.

Live values do not tick in a template

{{ animation.progress }} never updates; the return value tracks the instance, not the numbers inside it. Copy the value out from a callback:

const progress = ref(0)
useAnimate(box, { x: 400, onUpdate: self => progress.value = self.progress })

Text a composable rewrites must not re-render

useScrambleText and useSplitText write into the element. If Vue also renders the changing value there, they overwrite each other. Render the first value once and hand changes to the composable:

<script setup lang="ts">
useScrambleText(title, {}, () => ({ text: track.value.title }))
</script>

<template>
  <h2 ref="title" v-once>{{ track.title }}</h2>
</template>

For useSplitText, keep v-once and pass the new text through its html option.

Scramble timing goes in the third argument

AnimeJS scrambleText() sets its own duration, delay and ease, so the same keys in useScrambleText's second argument are ignored. Keep the second argument for playback and callbacks:

useScrambleText(title, { onComplete: next }, () => ({ text: text.value, duration: 2000 }))

Give list and layout groups deps

Without deps, <AnimeTransitionGroup> and <AnimeLayoutGroup> measure every element inside them on each re-render, even when nothing moved. A parent that passes a new object or array prop on every render re-renders them each time. Pass deps by default:

<AnimeTransitionGroup :deps="[]">       <!-- moves on add, remove, reorder -->
<AnimeTransitionGroup :deps="[view]">   <!-- also when view resizes items -->
<AnimeLayoutGroup :deps="[expanded]">   <!-- only when expanded changes -->

List every value whose change moves or resizes items. :deps="[]" on an <AnimeLayoutGroup> turns its animation off. Each move still measures every element inside the group, so keep item markup lean. On an <AnimeTransitionGroup> whose items only enter and leave, set :move-animation="false".

Reduced motion is a module option

nanime.reducedMotion in nuxt.config.ts takes 'never' (default), 'system' (follows prefers-reduced-motion) or 'always'. When motion is reduced, animations from the composables, transitions and groups jump to their end state. useDraggable and useAnimeScroll are not affected. To let visitors choose, call updateAppConfig({ nanime: { reducedMotion } }). Don't add your own prefers-reduced-motion checks around nanime calls.

Rebuilds restart the animation

When a reactive target or parameter changes, the composable reverts the old instance and builds a new one, from the start. Unchanged params are skipped, so a getter returning an identical fresh object costs nothing.

  • To continue mid-flight instead, pass { keepTime: true } as the last argument. Only useAnimate, useAnimeTimeline and useScrambleText take it.
  • For a value that retargets constantly, use useAnimatable.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts18d3 checks · Risk SAFE
  • Gen Agent Trust Hub18d

    The skill provides instructions for using the nanime Nuxt module. It is generally safe but identifies an indirect prompt injection surface through animation tools that process dynamic data without explicit sanitization requirements.

  • Socket18d

    No alerts

  • Snyk18d

    Risk: LOW · No issues

Signed by skilld at b4e1a3f. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 14 hours ago.

Activeupdated 3 weeks ago

README badge

README badge for onmax/nuxt-skills/nanime