v3.16
Nuxt on GitHub

Auto-imports

Source
Nuxt Kit provides a set of utilities to help you work with auto-imports. These functions allow you to register your own utils, composables and Vue APIs.

Nuxt auto-imports helper functions, composables and Vue APIs to use across your application without explicitly importing them. Based on the directory structure, every Nuxt application can also use auto-imports for its own composables and plugins.

With Nuxt Kit you can also add your own auto-imports. addImports and addImportsDir allow you to add imports to the Nuxt application. addImportsSources allows you to add listed imports from 3rd party packages to the Nuxt application.

These utilities are powered by unimport, which provides the underlying auto-import mechanism used in Nuxt.

These functions are designed for registering your own utils, composables and Vue APIs. For pages, components and plugins, please refer to the specific sections: Pages, Components, Plugins.
Watch Vue School video about Auto-imports Nuxt Kit utilities.

addImports

Add imports to the Nuxt application. It makes your imports available in the Nuxt application without the need to import them manually.

Usage

import { defineNuxtModule, addImports } from "@nuxt/kit";

export default defineNuxtModule({
  setup(options, nuxt) {
    const names = [
      "useStoryblok",
      "useStoryblokApi",
      "useStoryblokBridge",
      "renderRichText",
      "RichTextSchema"
    ];

    names.forEach((name) =>
      addImports({ name, as: name, from: "@storyblok/vue" })
    );
  }
})

Type

function addImports (imports: Import | Import[]): void

Parameters

imports: An object or an array of objects with the following properties:

PropTypeRequiredDescription
namestringtrueImport name to be detected.
fromstringtrueModule specifier to import from.
prioritynumberfalsePriority of the import; if multiple imports have the same name, the one with the highest priority will be used.
disabledbooleanfalseIf this import is disabled.
metaRecord<string, any>falseMetadata of the import.
typebooleanfalseIf this import is a pure type import.
typeFromstringfalseUse this as the from value when generating type declarations.
asstringfalseImport as this name.

addImportsDir

Add imports from a directory to the Nuxt application. It will automatically import all files from the directory and make them available in the Nuxt application without the need to import them manually.

Usage

import { defineNuxtModule, addImportsDir, createResolver } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: '@vueuse/motion',
    configKey: 'motion',
  },
  setup(options, nuxt) {
    const resolver = createResolver(import.meta.url)
    addImportsDir(resolver.resolve('./runtime/composables'))
  },
})

Type

function addImportsDir (dirs: string | string[], options?: { prepend?: boolean }): void

Parameters

PropTypeRequiredDescription
dirsstring | string[]trueA string or an array of strings with the path to the directory to import from.
options{ prepend?: boolean }falseOptions to pass to the import. If prepend is set to true, the imports will be prepended to the list of imports.

addImportsSources

Add listed imports to the Nuxt application.

Usage

import { defineNuxtModule, addImportsSources } from '@nuxt/kit'

export default defineNuxtModule({
  setup() {
    addImportsSources({
      from: 'h3',
      imports: [
        'defineEventHandler',
        'getQuery',
        'getRouterParams',
        'readBody',
        'sendRedirect'
      ],
    })
  }
})

Type

function addImportsSources (importSources: ImportSource | ImportSource[]): void

Parameters

importSources: An object or an array of objects with the following properties:

PropTypeRequiredDescription
fromstringtrueModule specifier to import from.
importsPresetImport | ImportSource[]trueAn object or an array of objects, which can be import names, import objects or import sources.