Vue

Use vue-convex directly in a Vue 3 app for shared Convex queries, mutations, pagination, auth state, storage, and advanced runtime control.

Use this track when your app is a standalone Vue 3 app or when you want to understand the shared runtime that also powers nuxt-convex.

This track owns:

  • the base convexVue plugin
  • shared composables for reads, writes, pagination, auth, and connection state
  • the advanced entrypoint for delayed connection and raw clients
  • the storage entrypoint for upload helpers

If you are building a Nuxt app, keep the Nuxt-side aliases in app code and use this track to understand the shared behavior underneath them.

Start with the Vue path

Open the page that matches your current task.

Install the plugin
Register convexVue, generate the API, and verify the first query.
Read data
Use reactive query arguments, SSR-aware reads, and skip logic.
Write data
Call mutations and actions, including optimistic updates for mutations.
Control the runtime
Connect later, reconfigure at runtime, or access the raw clients.
  • Read Convex Patterns for the backend model both tracks assume
  • Read API Reference for exact signatures and return types
  • Read Nuxt if you are working in a Nuxt app and need the wrapper contract
Copyright © 2026