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 相关文章推荐
如何判断图片地址是否失效
Feb 02 Javascript
javascript Event对象详解及使用示例
Nov 22 Javascript
js怎么覆盖原有方法实现重写
Sep 04 Javascript
js添加select下默认的option的value和text的方法
Oct 19 Javascript
js实现文字滚动效果
Mar 03 Javascript
Angularjs手动解析表达式($parse)
Oct 12 Javascript
微信小程序入门教程
Nov 18 Javascript
JS基于面向对象实现的拖拽功能示例
Dec 20 Javascript
jQuery 实现鼠标画框并对框内数据选中的实例代码
Aug 29 jQuery
webpack构建换肤功能的思路详解
Nov 27 Javascript
JS中数组与对象的遍历方法实例小结
Aug 14 Javascript
TypeScript中使用getElementXXX()的示例代码
Sep 12 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
PHP4.04简明安装
2006/10/09 PHP
php入门学习知识点一 PHP与MYSql连接与查询
2011/07/14 PHP
php读取文件内容的几种方法详解
2013/06/26 PHP
简单实用的.net DataTable导出Execl
2013/10/28 PHP
采用header定义为文件然后readfile下载(隐藏下载地址)
2014/01/31 PHP
php使用正则过滤js脚本代码实例
2014/05/10 PHP
PHP中使用循环实现的金字塔图形
2014/11/08 PHP
Javascript select控件操作大全(新增、修改、删除、选中、清空、判断存在等)
2008/12/19 Javascript
javascript 常用代码技巧大收集
2009/02/25 Javascript
表格单元格交错着色实现思路及代码
2013/04/01 Javascript
使用jQuery避免鼠标双击的解决方案
2013/08/21 Javascript
jQuery使用addClass()方法给元素添加多个class样式
2015/03/26 Javascript
JavaScript正则表达式之multiline属性的应用
2015/06/16 Javascript
JS实现点击复选框将按钮或文本框变为灰色不可用的方法
2015/08/11 Javascript
基于JavaScript实现鼠标箭头移动图片跟着移动
2016/08/30 Javascript
js正则表达式惰性匹配和贪婪匹配用法分析
2016/12/26 Javascript
socket.io与pm2(cluster)集群搭配的解决方案
2017/06/02 Javascript
JavaScript闭包和回调详解
2017/08/09 Javascript
使用puppeteer破解极验的滑动验证码
2018/02/24 Javascript
JS使用Prim算法和Kruskal算法实现最小生成树
2019/01/17 Javascript
实例分析编写vue组件方法
2019/02/12 Javascript
微信小程序登录时如何获取input框中的内容
2019/12/04 Javascript
Vue基于iview table展示图片实现点击放大
2020/08/05 Javascript
Vue包大小优化的实现(从1.72M到94K)
2021/02/18 Vue.js
python 字典的打印实现
2019/09/26 Python
python 命名规范知识点汇总
2020/02/14 Python
使用CSS3制作一个简单的Chrome模拟器
2015/07/15 HTML / CSS
Coach澳大利亚官方网站:美国著名时尚奢侈品牌
2017/05/24 全球购物
师范生自我鉴定范文
2013/10/05 职场文书
大学军训自我鉴定
2013/12/15 职场文书
应届毕业生求职自荐书
2014/01/03 职场文书
授权委托书格式模板
2014/04/03 职场文书
施工安全责任协议书
2016/03/23 职场文书
导游词之上海杜莎夫人蜡像馆
2019/11/22 职场文书
Java对文件的读写操作方法
2022/04/29 Java/Android
Vue 打包后相对路径的引用问题
2022/06/05 Vue.js