Does Custom Cursor work in Nuxt 3?

Yes. Drop it into any page or component. The component is client-safe; Nuxt handles the SSR boundary automatically. If you want explicit client-only rendering, wrap in ` `.

Does Custom Cursor work with Vue 2?

No - the component uses the Vue 3 Composition API and ` ` syntax. Vue 2 support is not planned. If you need Vue 2, the HTML/CSS/JS variant works in any context.

Does Custom Cursor work with TypeScript in Vue?

Yes. The component is typed and works with both `vue-tsc` and Volar. Props match the `data-anm-*` attributes documented on the main detail page.

Will the animation flash before hydration in Nuxt SSR?

Brief flash is possible because GSAP needs the client to initialize. The component sets the parked state via `gsap.set` on `onMounted` before the first paintable frame. For above-the-fold use in SSR contexts, add a CSS opacity:0 default that the component clears.

GSAP component for Vue

Custom Cursor in Vue.

A custom cursor that follows your mouse smoothly and can show a little label when you hover things. Desktop only, it turns itself off on touch.

Built for drinkbodyarmor.com.

Install

Install Custom Cursor in your Vue project

Custom Cursor ships as a copy-paste Vue 3 single-file component. The only dependency is GSAP - Vue's reactivity and lifecycle hooks replace the React useGSAP adapter, so no extra package is needed.

BASH

Integrate

Where it goes in your Vue app

Custom Cursor is a leaf-level interactive component. Drop it into any page, layout, or other component. It works in Vue 3 + Vite, Nuxt 3, and any standalone Vue setup.

In Nuxt, no special handling is needed - the component is client-safe and self-cleaning. If you want to ensure it never runs on the server (rare), wrap your usage in <ClientOnly>.

The component uses the <script setup> composition API and TypeScript-friendly defineProps.

Gotchas

Nuxt SSR flash

This component parks its initial state inside onMounted, which runs client-side only. In Nuxt SSR the un-parked DOM paints briefly before hydration. Wrap in <ClientOnly> or add a CSS opacity:0 default the component clears.

Template refs in Vue

Refs are accessed as .value, not .current. Pass elementRef.value to gsap.to() / gsap.from() targets.

FAQ

Common questions

Does Custom Cursor work in Nuxt 3?: Yes. Drop it into any page or component. The component is client-safe; Nuxt handles the SSR boundary automatically. If you want explicit client-only rendering, wrap in .
Does Custom Cursor work with Vue 2?: No - the component uses the Vue 3 Composition API and