Vue 组件注册实例详解

2023-08-28 15:34:04 146

本文实例讲述了Vue组件注册。分享给大家供大家参考，具体如下：

1组件名

在注册一个组件的时候，我们始终需要给它一个名字。比如在全局注册的时候我们已经看到了：

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

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

你给予组件的名字可能依赖于你打算拿它来做什么。当直接在DOM中使用一个组件(而不是在字符串模板或单文件组件)的时候，我们强烈推荐遵循W3C规范中的自定义组件名(字母全小写且必须包含一个连字符)。这会帮助你避免和当前以及未来的HTML元素相冲突。

你可以在风格指南中查阅到关于组件名的其它建议。

2组件名大小写

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

使用kebab-case

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

当使用kebab-case(短横线分隔命名)定义一个组件时，你也必须在引用这个自定义元素时使用kebab-case，例如。

使用PascalCase

Vue.component('MyComponentName',{/*...*/})

当使用PascalCase(驼峰式命名)定义一个组件时，你在引用这个自定义元素时两种命名法都可以使用。也就是说和都是可接受的。注意，尽管如此，直接在DOM(即非字符串的模板)中使用时只有kebab-case是有效的。

3全局注册

到目前为止，我们只用过Vue.component来创建组件：

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

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

html：

js：

Vue.component('component-a',{/*...*/})
Vue.component('component-b',{/*...*/})
Vue.component('component-c',{/*...*/})
newVue({el:'#app'})

在所有子组件中也是如此，也就是说这三个组件在各自内部也都可以相互使用。

4局部注册

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

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

varComponentA={/*...*/}
varComponentB={/*...*/}
varComponentC={/*...*/}

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

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

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

注意局部注册的组件在其子组件中不可用。例如，如果你希望ComponentA在ComponentB中可用，则你需要这样写：

varComponentA={/*...*/}
varComponentB={
components:{
'component-a':ComponentA
},
//...
}

或者如果你通过Babel和webpack使用ES2015模块，那么代码看起来更像：

importComponentAfrom'./ComponentA.vue'
exportdefault{
components:{
ComponentA
},
//...
}

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

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

5模块系统

如果你没有通过import/require使用一个模块系统，也许可以暂且跳过。如果你使用了，那么我们会为你提供一些特殊的使用说明和注意事项。

5.1在模块系统中局部注册

如果你还在阅读，说明你使用了诸如Babel和webpack的模块系统。在这些情况下，我们推荐创建一个components目录，并将每个组件放置在其各自的文件中。

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

importComponentAfrom'./ComponentA'
importComponentCfrom'./ComponentC'
exportdefault{
components:{
ComponentA,
ComponentC
},
//...
}

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

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

可能你的许多组件只是包裹了一个输入框或按钮之类的元素，是相对通用的。我们有时候会把它们称为基础组件，它们会在各个组件中被频繁的用到。

所以会导致很多组件里都会有一个包含基础组件的长列表：

importBaseButtonfrom'./BaseButton.vue'
importBaseIconfrom'./BaseIcon.vue'
importBaseInputfrom'./BaseInput.vue'
exportdefault{
components:{
BaseButton,
BaseIcon,
BaseInput
}
}

而只是用于模板中的一小部分：

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

importVuefrom'vue'
importupperFirstfrom'lodash/upperFirst'
importcamelCasefrom'lodash/camelCase'
constrequireComponent=require.context(
//其组件目录的相对路径
'./components',
//是否查询其子目录
false,
//匹配基础组件文件名的正则表达式
/Base[A-Z]\w+\.(vue|js)$/
)
requireComponent.keys().forEach(fileName=>{
//获取组件配置
constcomponentConfig=requireComponent(fileName)
//获取组件的PascalCase命名
constcomponentName=upperFirst(
camelCase(
//剥去文件名开头的`'./`和结尾的扩展名
fileName.replace(/^\.\/(.*)\.\w+$/,'$1')
)
)
//全局注册组件
Vue.component(
componentName,
//如果这个组件选项是通过`exportdefault`导出的，
//那么就会优先使用`.default`，
//否则回退到使用模块的根。
componentConfig.default||componentConfig
)
})

记住全局注册的行为必须在根Vue实例(通过newVue)创建之前发生。这里有一个真实项目情景下的示例。

希望本文所述对大家vue.js程序设计有所帮助。

Vue 组件注册实例详解

热门推荐

随机推荐