W3C 规范中的自定义组件名 (字母全小写且必须包含一个连字符)。
基础组件的自动化全局注册
可能你的许多组件只是包裹了一个输入框或按钮之类的元素,是相对通用的。我们有时候会把它们称为基础组件,它们会在各个组件中被频繁的用到。
所以会导致很多组件里都会有一个包含基础组件的长列表:
1 import BaseButton from './BaseButton.vue' 2 import BaseIcon from './BaseIcon.vue' 3 import BaseInput from './BaseInput.vue' 4 5 export default { 6 components: { 7 BaseButton, 8 BaseIcon, 9 BaseInput 10 } 11 }
而只是用于模板中的一小部分:
<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
) 创建之前发生。
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
这些组件为你的应用奠定了一致的基础样式和行为。它们可能只包括:
HTML 元素
其它基础组件
第三方 UI 组件库
但是它们绝不会包括全局状态 (比如来自 Vuex store)。
它们的名字通常包含所包裹元素的名字 (比如 BaseButton、BaseTable),除非没有现成的对应功能的元素 (比如 BaseIcon)。如果你为特定的上下文构建类似的组件,那它们几乎总会消费这些组件 (比如 BaseButton 可能会用在 ButtonSubmit 上)。
这样做的几个好处:
当你在编辑器中以字母顺序排序时,你的应用的基础组件会全部列在一起,这样更容易识别。
因为组件名应该始终是多个单词,所以这样做可以避免你在包裹简单组件时随意选择前缀 (比如 MyButton、VueButton)。