Convex
×
Nuxt

Nuxt Module

[object Object]

This section documents what nuxt-convex adds on top of the shared Vue runtime. Use it when you need the exact Nuxt-facing contract rather than the shared composable behavior.

What this section covers

  • the convex module configuration key
  • #convex, #convex/api, #convex/advanced, and optional #convex/storage
  • Nuxt auto-imports
  • global renderless components
  • storage scaffolding
  • the Nuxt-side Cloudflare R2 helper

In other words, this section covers the public #convex, #convex/api, and #convex/advanced aliases, plus the Optional #convex/storage alias when the storage feature is enabled.

Open a Nuxt-specific guide

Review module configuration
Look up the supported config keys, defaults, env fallback order, and runtime behavior.
Set up Convex storage
Enable storage scaffolding and use the Nuxt storage alias in app code.
Set up Cloudflare R2
Enable the Nuxt-only upload helper for the Convex R2 component.
Review virtual modules
Check which aliases exist by default and which ones depend on optional features.

Related sections

  • Read Nuxt for the top-level Nuxt track
  • Read Integrations for Better Auth and R2
  • Read Vue for shared composable behavior

Installation

Install the package that matches your app, generate the Convex API, and verify the setup with a first query.

File Storage

Enable Convex storage scaffolding in nuxt-convex and use the Nuxt storage helpers in app code.

Copyright © 2026