Module to register global components for Nuxt.js
NuxtJS Team released @nuxt/components to auto import components when used in templates, allowing better performances and features.
If you want to migrate from this module, you will simply have to remove the .global suffix.
Suffix your components with .global.{ext} to declare your global components.
components/
my-component.vue # local component, import it to use it
my-button.global.vue # global component, no need to register it!See live demo.
- Add
@nuxtjs/global-componentsdependency to your project
yarn add --dev @nuxtjs/global-components # or npm install --save-dev @nuxtjs/global-components- Add
@nuxtjs/global-componentsto thebuildModulessection ofnuxt.config.js
export default {
buildModules: [
// Simple usage
'@nuxtjs/global-components',
// With options
['@nuxtjs/global-components', { /* module options */ }]
]
}dependency (No --dev or --save-dev flags) and use modules section in nuxt.config.js instead of buildModules.
export default {
buildModules: [
'@nuxtjs/global-components'
],
globalComponents: {
/* module options */
}
}- Type:
String|Array - Default:
components
A list of directories to find components inside your nuxt project.
- Type:
Array - Default:
['global']
The suffixes that files can contain.
- Type:
Array - Default:
['vue', 'js', 'ts']
The extensions that files can contain.
- Type:
Array - Default:
[]
An array of glob patterns to exclude matches.
- Type:
Boolean - Default:
false
Ignore name detection using prototype names.
Insipired by nuxtjs.org
Copyright (c) Nuxt Community
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent