Repository files navigation

Unleash Nuxt Developer Experience.
Nuxt DevTools is a set of visual tools that help you to know your app better.

👋 Introduction |💡 Ideas & Suggestions |🗺️ Project Roadmap |📚 Documentation

Nuxt DevTools v2 requiresNuxt v3.15.0 or higher.

Nuxt DevTools isenabled by default in Nuxt v3.8.0. You can pressShift +Alt /⇧ Shift +⌥ Option +D in your app to open it up.

If you want to explicitly enable or disable Nuxt DevTools, you can update yournuxt.config with:

exportdefaultdefineNuxtConfig({devtools:{enabled:true// or false to disable}})

Similar toNuxt's Nightly Channel, DevTools also offers a nightly release channel, that automatically releases for every commit tomain branch.

You can opt-in to the nightly release channel by running:

{  "devDependencies": {--    "@nuxt/devtools": "^0.1.0"++    "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"  }}

Remove lockfile (package-lock.json,yarn.lock, orpnpm-lock.yaml) and reinstall dependencies.

To configure Nuxt DevTools, you can pass thedevtools options.

// nuxt.config.tsexportdefaultdefineNuxtConfig({devtools:{// Enable devtools (default: true)enabled:true,// VS Code Server optionsvscode:{},// ...other options}})

For all options available, please refer to TSDocs in your IDE, or thetype definition file.

Read theAnnouncement Blog Post 🎊 for why we built Nuxt DevTools and what it can do!

Please refer to theModule Authors Guide.

Please refer to theContribution Guide.

Nuxt DevTools collects anonymous telemetry data about general usage. This helps us to accurately gauge feature usage and customization across all our users. This data will let us better understand how each features in Nuxt DevTools are used, measuring improvements made (DX and performances) and their relevance. It would also help us to prioritize our efforts and focus on the features that matter the most to our users.

Nuxt DevTools' telemetry data is piped throughNuxt Telemetry, meaning that Nuxt DevTools will respect your local and global Nuxt Telemetry settings. You can also opt-out Nuxt DevTools' telemetry in the Nuxt DevTools settings.

The data we collect is completely anonymous, not traceable to the source (using hash+seed), and only meaningful in aggregate form. No data we collect is personally identifiable or trackable.

On top of thedefault Nuxt Telemetry events, Nuxt DevTools also collects the following events:

• Versions of Nuxt DevTools
• Navigations between tabs/feature
  • This helps us to understand which features are used the most to prioritize our efforts.
• Browser and OS names and versions
  • This helps us improve compatibility across different browsers and operating systems.
• Click event on some action buttons

MIT