Vue 组件注册实例详解


Posted in Javascript onFebruary 23, 2019

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

1 组件名

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

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

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

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

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

2 组件名大小写

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

使用 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 是有效的。

3 全局注册

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

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

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

html:

<div id="app">
 <component-a></component-a>
 <component-b></component-b>
 <component-c></component-c>
</div>

js:

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

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

4 局部注册

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

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

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

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

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

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

注意局部注册的组件在其子组件中不可用。例如,如果你希望 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 的缩写,即这个变量名同时是:

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

5 模块系统

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

5.1 在模块系统中局部注册

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

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

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

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

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

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

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

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.replace(/^\.\/(.*)\.\w+$/, '$1')
  )
 )
 // 全局注册组件
 Vue.component(
  componentName,
  // 如果这个组件选项是通过 `export default` 导出的,
  // 那么就会优先使用 `.default`,
  // 否则回退到使用模块的根。
  componentConfig.default || componentConfig
 )
})

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

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

Javascript 相关文章推荐
初学js插入节点appendChild insertBefore使用方法
Jul 04 Javascript
js实现文章文字大小字号功能完整实例
Nov 01 Javascript
javascript发送短信验证码实现代码
Nov 12 Javascript
JS操作JSON方法总结(推荐)
Jun 14 Javascript
Node.js调试技术总结分享
Mar 12 Javascript
Angular.Js中ng-include指令的使用与实现
May 07 Javascript
微信小程序用户信息encryptedData详解
Aug 24 Javascript
详解Vue组件插槽的使用以及调用组件内的方法
Nov 13 Javascript
vue-router启用history模式下的开发及非根目录部署方法
Dec 23 Javascript
vue分页器组件编写方法详解
Jun 28 Javascript
ES6 新增的创建数组的方法(小结)
Aug 01 Javascript
Auto.JS实现抖音刷宝等刷视频app,自动点赞,自动滑屏,自动切换视频功能
May 08 Javascript
Vue Prop属性功能与用法实例详解
Feb 23 #Javascript
Vue自定义属性实例分析
Feb 23 #Javascript
Vue动态组件与异步组件实例详解
Feb 23 #Javascript
详解单页面路由工程使用微信分享及二次分享解决方案
Feb 22 #Javascript
详解关于Vuex的action传入多个参数的问题
Feb 22 #Javascript
Vue.js实现开发购物车功能的方法详解
Feb 22 #Javascript
vue组件之间通信方式实例总结【8种方式】
Feb 22 #Javascript
You might like
APMServ使用说明
2006/10/23 PHP
坏狼php学习 计数器实例代码
2008/06/15 PHP
Zend的MVC机制使用分析(二)
2013/05/02 PHP
php使用cookie保存用户登录的用户名实例
2015/01/26 PHP
php实现根据身份证获取精准年龄
2020/02/26 PHP
JavaScript学习笔记记录我的旅程
2012/05/23 Javascript
JS自动缩小超出大小的图片
2012/10/12 Javascript
js+数组实现网页上显示时间/星期几的实用方法
2013/01/18 Javascript
jquery xMarquee实现文字水平无缝滚动效果
2014/04/29 Javascript
AngularJS学习笔记(三)数据双向绑定的简单实例
2016/11/08 Javascript
jQuery点击导航栏选中更换样式的实现代码
2017/01/23 Javascript
详解使用Node.js 将txt文件转为Excel文件
2017/07/05 Javascript
JavaScript实现创建自定义对象的常用方式总结
2018/07/09 Javascript
用node.js写一个jenkins发版脚本
2019/05/21 Javascript
[01:00]选手抵达华西村 整装待发备战2016国际邀请赛中国区预选赛
2016/06/25 DOTA
Python IDLE入门简介
2017/12/08 Python
TensorFlow平台下Python实现神经网络
2018/03/10 Python
用TensorFlow实现lasso回归和岭回归算法的示例
2018/05/02 Python
Python闭包函数定义与用法分析
2018/07/20 Python
Python rstrip()方法实例详解
2018/11/11 Python
Python3多目标赋值及共享引用注意事项
2019/05/27 Python
python覆盖写入,追加写入的实例
2019/06/26 Python
python图形开发GUI库wxpython使用方法详解
2020/02/14 Python
Python基于yield遍历多个可迭代对象
2020/03/12 Python
Python脚本如何在bilibili中查找弹幕发送者
2020/06/04 Python
Python Mock模块原理及使用方法详解
2020/07/07 Python
Python中免验证跳转到内容页的实例代码
2020/10/23 Python
使用Python爬取小姐姐图片(beautifulsoup法)
2021/02/11 Python
加拿大百叶窗和窗帘定制网站:Blinds
2017/01/30 全球购物
2014年中班元旦活动方案
2014/02/14 职场文书
医德医风个人工作总结2014
2014/11/14 职场文书
2015年教师节感恩寄语
2015/03/23 职场文书
入伍通知书
2015/04/23 职场文书
社区党支部公开承诺书
2015/04/29 职场文书
2016年习总书记讲话学习心得体会
2016/01/20 职场文书
Java中API的使用方法详情
2022/04/06 Java/Android