@nuxtjs/global-components

Module to register global components for Nuxt.js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@nuxtjs/global-components
5610.6.13 years ago3 years agoMinified + gzip package size for @nuxtjs/global-components in KB

Readme

@nuxtjs/global-components
!npm versionnpm-version-srcnpm-version-href !npm downloadsnpm-downloads-srcnpm-downloads-href !Circle CIcircle-ci-srccircle-ci-href !Codecovcodecov-srccodecov-href !Licenselicense-srclicense-href
Module to register global components for Nuxt.js

📖 Release Notes

Usage

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.

Setup

  1. Add @nuxtjs/global-components dependency to your project

yarn add --dev @nuxtjs/global-components # or npm install --save-dev @nuxtjs/global-components

  1. Add @nuxtjs/global-components to the buildModules section of nuxt.config.js

export default {
  buildModules: [
    // Simple usage
    '@nuxtjs/global-components',

    // With options
    ['@nuxtjs/global-components', { /* module options */ }]
  ]
}

:warning: If you are using Nuxt < v2.9 you have to install the module as a dependency (No --dev or --save-dev flags) and use modules section in nuxt.config.js instead of buildModules.

Using top level options

export default {
  buildModules: [
    '@nuxtjs/global-components'
  ],
  globalComponents: {
    /* module options */
  }
}

Options

dir

  • Type: String|Array
  • Default: components

A list of directories to find components inside your nuxt project.

suffixes

  • Type: Array
  • Default: ['global']

The suffixes that files can contain.

extensions

  • Type: Array
  • Default: ['vue', 'js', 'ts']

The extensions that files can contain.

ignore

  • Type: Array
  • Default: []

An array of glob patterns to exclude matches.

ignoreNameDetection

  • Type: Boolean
  • Default: false

Ignore name detection using prototype names.

License

MIT License
Insipired by nuxtjs.org
Copyright (c) Nuxt Community