Nuxt Kit

Nuxt Kit provides composable utilities to make interacting with Nuxt Hooks, the Nuxt Interface and developing Nuxt modules super easy.

::read-more{to="/docs/4.x/api/kit"} Discover all Nuxt Kit utilities. ::

Usage

Install Dependency

You can install the latest Nuxt Kit by adding it to the dependencies section of your package.json. However, please consider always explicitly installing the @nuxt/kit package even if it is already installed by Nuxt.

::note @nuxt/kit and @nuxt/schema are key dependencies for Nuxt. If you are installing it separately, make sure that the versions of @nuxt/kit and @nuxt/schema are equal to or greater than your nuxt version to avoid any unexpected behavior. ::

{
  "dependencies": {
    "@nuxt/kit": "npm:@nuxt/kit-nightly@latest"
  }
}

Import Kit Utilities

import { useNuxt } from '@nuxt/kit'

:read-more{to="/docs/4.x/api/kit"}

::note Nuxt Kit utilities are only available for modules and not meant to be imported in runtime (components, Vue composables, pages, plugins, or server routes). ::

Nuxt Kit is an esm-only package meaning that you cannot require('@nuxt/kit'). As a workaround, use dynamic import in the CommonJS context:

// This does NOT work!
// const kit = require('@nuxt/kit')
async function main () {
  const kit = await import('@nuxt/kit')
}
main()