组件注册
组件名:字母全小写且必须包含一个连字符
Vue.component('my-component-name', { /* ... */ })
定义组件名的方式有两种:kebab-case短横线命名法(短横线分隔命名)、PascalCase帕斯卡命名法 (首字母大写命名)
注意:当使用PascalCase (首字母大写命名)定义组件时,你在引用这个自定义元素时两种命名法都可以使用。但是直接在 DOM (即非字符串的模板) 中使用时只有 kebab-case 是有效的。
全局注册
Vue.component 创建的是全局组件,在注册之后可以用在任何新创建的 Vue 根实例 (
new Vue
) 的模板中。Vue.component('component-a', { /* ... */ }) Vue.component('component-b', { /* ... */ }) Vue.component('component-c', { /* ... */ }) new Vue({ el: '#app' })
<div id="app"> <component-a></component-a> <component-b></component-b> <component-c></component-c> </div>
因为是全局组件,所以这三个组件在各自内部也都可以相互使用。
局部注册
通过一个普通的 JavaScript 对象来定义组件,然后在 components 选项中定义要使用的组件。对于
components
对象中的每个属性来说,其属性名就是自定义元素的名字,其属性值就是这个组件的选项对象。// 定义组件 var ComponentA = { /* ... */ } var ComponentB = { /* ... */ } var ComponentC = { /* ... */ } new Vue({ el: '#app', components: { 'component-a': ComponentA, 'component-b': ComponentB } })
注意局部注册的组件在其子组件中不可用。例如,如果你希望
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
的缩写,即这个变量名同时是:用在模板中的自定义元素的名称、包含了这个组件选项的变量名模块系统:通过
import
/require
使用一个模块系统。在模块系统中局部注册
需要使用诸如 Babel 和 webpack 的模块系统。在这些情况下,我们推荐创建一个
components
目录,并将每个组件放置在其各自的文件中。然后你需要在局部注册之前导入每个你想使用的组件。例如,在一个假设的
ComponentB.js
或ComponentB.vue
文件中:import ComponentA from './ComponentA' import ComponentC from './ComponentC' export default { components: { ComponentA, ComponentC }, // ... }
这样
ComponentA
和ComponentC
都可以在ComponentB
的模板中使用了。基础组件的自动化全局注册
可能你的许多组件只是包裹了一个输入框或按钮之类的元素,是相对通用的。我们有时候会把它们称为基础组件,它们会在各个组件中被频繁的用到。
如果你使用了 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
) 创建之前发生。这里有一个真实项目情景下的示例。