详解Vue注册组件的方法

目录

• 简介
• 说明
• 官网网址
• 组件名字
• 全局注册（一般用于框架）
• 局部注册（不常用）
• 模块系统
• 在模块系统中局部注册（常用）
• 基础组件的自动化全局注册

简介

说明

本文介绍Vue注册组件的方法。

Vue注册组件有这几种：全局注册、局部注册、在模块系统中注册。

官网网址

https://v2.cn.vuejs.org/v2/guide/components-registration.html

组件名字

注册一个组件的时候，需要给它一个名字。比如在全局注册：

Vue.component('my-component-name', { /* ... */ })

组件名是 Vue.component 的第一个参数。

当直接在 DOM 中使用一个组件 (而不是在字符串模板或单文件组件) 的时候，强烈推荐遵循 W3C 规范中的自定义组件名 (字母全小写且必须包含一个连字符)。这会帮助你避免和其他HTML 元素相冲突。

定义组件名的方式有两种：

• 使用 kebab-case
• Vue.component('my-component-name', { /* ... */ })
• 当使用 kebab-case (短横线分隔命名) 定义一个组件时，你也必须在引用这个自定义元素时使用 kebab-case，例如 <my-component-name>。
• 使用 PascalCase
• Vue.component('MyComponentName', { /* ... */ })
• 当使用 PascalCase (首字母大写命名) 定义一个组件时，你在引用这个自定义元素时两种命名法都可以使用。也就是说 <my-component-name> 和 <MyComponentName> 都是可接受的。注意，尽管如此，直接在 DOM (即非字符串的模板) 中使用时只有 kebab-case 是有效的。

全局注册（一般用于框架）

写法

Vue.component('my-component-name', {
  // ... 选项 ...
})

或者

Vue.component("tmp2", Vue.extend({
        template: "<p>通过 Vue.extend 创建的 tmp2 组件</p>"
    }));

上边第1种写法（没有Vue.extend）：Vue默认自动调用Vue.extend()。

示例

Vue.component("counter",
  {
	data(){
			return {count:0}
		},

	template: '<button v-on:click="count++">点击计算点击次数：{{count}}次</button>'
  }
)

这些组件是全局注册的。也就是说它们在注册之后可以用在任何新创建的 Vue 根实例 (new Vue) 的模板中。

很多Vue的前端框架都是全局注册组件的，例如vue-element-admin：

src/index.js：

import Pagination from '../packages/pagination/index.js';
import Dialog from '../packages/dialog/index.js';
// 其他代码

const components = [
  Pagination,
  Dialog,
  // 其他代码
];

const install = function(Vue, opts = {}) {
  // 其他代码

  components.forEach(component => {
    Vue.component(component.name, component);
  });
}

局部注册（不常用）

说明

有些场景不适合使用全局注册。比如，使用一个像 webpack 这样的构建系统，全局注册所有的组件意味着即便你已经不再使用一个组件了，它仍然会被包含在你最终的构建结果中。这造成了用户下载的 JavaScript 的无谓的增加。

在这些情况下，可以通过一个普通的 JavaScript 对象来定义组件：

var ComponentA = { /* ... */ }
var ComponentB = { /* ... */ }
var ComponentC = { /* ... */ }

然后在 components 选项中定义你想要使用的组件：

new Vue({
  el: '#app',
  components: {
    'component-a': ComponentA,
    'component-b': ComponentB
  }
})

对于 components 对象中的每个 property 来说，其 property 名就是自定义元素的名字，其 property 值就是这个组件的选项对象。

局部注册的组件在其子组件中不可用

例如，如果你希望 ComponentA 在 ComponentB 中可用，则你需要这样写：

var ComponentA = { /* ... */ }

var ComponentB = {
  components: {
    'component-a': ComponentA
  },
  // ...
}

或者如果你通过 Babel 和 webpack 使用 ES2015 模块，代码这样写：

import ComponentA from './ComponentA.vue'
export default {
  components: {
    ComponentA
  },
  // ...
}

注意

在 ES2015+ 中，在对象中放一个类似 ComponentA 的变量名其实是 ComponentA: ComponentA 的缩写，即这个变量名同时是：

• 用在模板中的自定义元素的名称
• 包含了这个组件选项的变量名

模块系统

在模块系统中局部注册（常用）

项目中我们一般使用Babel 或 webpack 的模块系统。这时，我们一般创建一个 components 目录，并将每个组件放置在其各自的文件中。

然后在局部注册之前导入每个你想使用的组件。例如，在一个假设的 ComponentB.js 或 ComponentB.vue 文件中：

import ComponentA from './ComponentA'
import ComponentC from './ComponentC'

export default {
  components: {
    ComponentA,
    ComponentC
  },
  // ...
}

现在 ComponentA 和 ComponentC 都可以在 ComponentB 的模板中使用了。

实例：Vue--props--使用/教程/实例

基础组件的自动化全局注册

通用组件一般只包裹了一个输入框或按钮之类的元素，可以把它们称为基础组件。各个组件都会用到这些通用组件。

这样会导致组件里都会有一个包含基础组件的长列表：

import BaseButton from './BaseButton.vue'
import BaseIcon from './BaseIcon.vue'
import BaseInput from './BaseInput.vue'

export default {
  components: {
    BaseButton,
    BaseIcon,
    BaseInput
  }
}

但这个基础组件只是用于模板中的一小部分：

<BaseInput
  v-model="searchText"
  @keydown.enter="search"
/>
<BaseButton @click="search">
  <BaseIcon name="search"/>
</BaseButton>

如果你使用了 webpack (或在内部使用了 webpack 的 Vue CLI 3+)，那么就可以使用 require.context 只全局注册这些非常通用的基础组件。在应用入口文件 (比如 src/main.js) 中全局导入基础组件的示例代码：

import Vue from 'vue'
import upperFirst from 'lodash/upperFirst'
import camelCase from 'lodash/camelCase'

const requireComponent = require.context(
  // 其组件目录的相对路径
  './components',
  // 是否查询其子目录
  false,
  // 匹配基础组件文件名的正则表达式
  /Base[A-Z]\w+\.(vue|js)$/
)

requireComponent.keys().forEach(fileName => {
  // 获取组件配置
  const componentConfig = requireComponent(fileName)

  // 获取组件的 PascalCase 命名
  const componentName = upperFirst(
    camelCase(
      // 获取和目录深度无关的文件名
      fileName
        .split('/')
        .pop()
        .replace(/\.\w+$/, '')
    )
  )

  // 全局注册组件
  Vue.component(
    componentName,
    // 如果这个组件选项是通过 `export default` 导出的，
    // 那么就会优先使用 `.default`，
    // 否则回退到使用模块的根。
    componentConfig.default || componentConfig
  )
})

全局注册的行为必须在根 Vue 实例 (通过 new Vue) 创建之前发生。

到此这篇关于Vue注册组件的方法的文章就介绍到这了,更多相关Vue注册组件内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！