nuxt-reveal
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 354
- Avg merge
- 10h 18m
- Merged PRs (30d)
- 12
Description
✨ Module proposal: nuxt-reveal
Hello Nuxt team 👋
I would like to propose my module nuxt-reveal for inclusion in the official nuxt-modules organization.
📦 Module description
nuxt-reveal is a lightweight Nuxt module that provides scroll-based reveal animations using the native IntersectionObserver.
It allows developers to easily animate elements when they enter the viewport, with support for:
v-revealdirective (single element animation)v-reveal-group(staggered group animations)- Per-element delay via
data-delay - SSR-safe implementation
- Zero external dependencies
- Compatibility with any CSS animation system (Tailwind, animate.css, custom CSS)
🔗 Repository
GitHub: https://github.com/domutala/nuxt-reveal
npm: https://www.npmjs.com/package/nuxt-reveal
🚀 Features
- Lightweight and performant (based on IntersectionObserver)
- Simple API using directives
- Group animations with stagger support
- Fully SSR compatible (Nuxt 3)
- Works with any animation library or custom CSS
- No dependencies
💡 Motivation
I built this module to provide a simple and flexible way to handle scroll animations in Nuxt 3 applications without relying on heavy animation libraries.
The goal is to keep it:
- minimal
- extensible
- production-ready
🧱 Tech details
- Nuxt 3 module
- TypeScript
- Vue 3 directives
- IntersectionObserver API
- Zero runtime dependencies
📦 Current status
- Already published on npm
- Working in production projects
- Actively maintained
🙏 Why joining nuxt-modules
I would love to join nuxt-modules to:
- ensure long-term maintenance
- improve visibility and adoption
- collaborate with the Nuxt ecosystem team
- benefit from shared best practices
- possibly move the package under
@nuxtjs/nuxt-reveal
📌 Additional notes
I am open to:
- renaming the package under the
@nuxtjs/scope - adapting to Nuxt module standards
- adding required CI / testing / docs setup
- migrating documentation to
nuxtjs.orgsubdomain if needed
Thank you for your time and for building such an amazing ecosystem 🙏
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The payload names no file, test, or entry point in nuxt/modules; begin by reviewing the proposed module at https://github.com/domutala/nuxt-reveal and the repository's contribution expectations. Done would require a maintainer decision on inclusion, followed by any requested Nuxt module standards, CI, testing, or documentation work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nuxtjs, typescript
- Domain
- frontend, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100