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 相关文章推荐
Javascript实例教程(19) 使用HoTMetal(7)
Dec 23 Javascript
jQuery html() in Firefox (uses .innerHTML) ignores DOM changes
Mar 05 Javascript
再论Javascript的类继承
Mar 05 Javascript
你必须知道的Javascript知识点之&quot;this指针&quot;的应用
Apr 23 Javascript
jquery实现图片裁剪思路及实现
Aug 16 Javascript
js判断页面中是否有指定控件的简单实例
Mar 04 Javascript
深入理解JavaScript系列(18):面向对象编程之ECMAScript实现
Mar 05 Javascript
AngularJS实现使用路由切换视图的方法
Jan 24 Javascript
简单介绍react redux的中间件的使用
Apr 06 Javascript
Webpack 4.x搭建react开发环境的方法步骤
Aug 15 Javascript
JS中DOM元素的attribute与property属性示例详解
Sep 04 Javascript
JavaScript实现飞舞的泡泡效果
Feb 07 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
php仿ZOL分页类代码
2008/10/02 PHP
关于PHP内存溢出问题的解决方法
2013/06/25 PHP
PHP分页详细讲解(有实例)
2013/10/30 PHP
php可变长参数处理函数详解
2017/02/22 PHP
让你的网站可编辑的实现js代码
2009/10/19 Javascript
jQuery学习3:操作元素属性和特性
2010/02/07 Javascript
AppBaseJs 类库 网上常用的javascript函数及其他js类库写的
2010/03/04 Javascript
如何防止回车(enter)键提交表单
2014/05/11 Javascript
Node.js实现在目录中查找某个字符串及所在文件
2014/09/03 Javascript
jquery获取radio值(单选组radio)
2014/10/16 Javascript
jQuery入门介绍之基础知识
2015/01/13 Javascript
JS使用cookie实现DIV提示框只显示一次的方法
2015/11/05 Javascript
jQuery中的siblings用法实例分析
2015/12/24 Javascript
深入理解JS DOM事件机制
2016/08/06 Javascript
javaScript语法总结
2016/11/25 Javascript
微信小程序 MD5加密登录密码详解及实例代码
2017/01/12 Javascript
vue实现点击图片放大效果
2017/08/15 Javascript
Angular7.2.7路由使用初体验
2019/03/01 Javascript
Electron vue的使用教程图文详解
2019/07/05 Javascript
[34:56]Ti4冒泡赛LGD vs Liquid 1
2014/07/14 DOTA
python测试驱动开发实例
2014/10/08 Python
python写日志封装类实例
2015/06/28 Python
Python实现识别手写数字 Python图片读入与处理
2020/03/23 Python
Python迭代器与生成器基本用法分析
2018/07/26 Python
python实现简单五子棋游戏
2019/06/18 Python
基于python检查矩阵计算结果
2020/05/21 Python
Keras设定GPU使用内存大小方式(Tensorflow backend)
2020/05/22 Python
html5调用摄像头功能的实现代码
2018/05/07 HTML / CSS
荷兰演唱会和体育比赛订票网站:viagogo荷兰
2018/04/08 全球购物
如何判断一段程序是由C 编译程序还是由C++编译程序编译的
2013/08/04 面试题
在数据文件自动增长时,自动增长是否会阻塞对文件的更新
2014/05/01 面试题
.net软件工程师应聘上机试题
2015/03/10 面试题
Shell编程面试题
2016/05/29 面试题
大学生个人事迹材料
2014/01/21 职场文书
公开服务承诺制度
2014/03/26 职场文书
新闻专业毕业生求职信
2014/08/08 职场文书