• 首页
  • vue
  • TypeScript
  • JavaScript
  • scss
  • css3
  • html5
  • php
  • MySQL
  • redis
  • jQuery
  • 组件注册

    一个 Vue 组件需要被“注册”使得 Vue 在渲染模板时能找到其实现。有两种方式来注册组件:全局注册和局部注册。

    全局注册

    我们可以使用app.component()方法,让组件在当前 Vue 应用中全局可用。

    import { createApp } from 'vue'
    const app = createApp({})
    
    app.component(
      // 注册的名字
      'MyComponent',
      // 组件的实现
      {
        /* ... */
      }
    )
    

    如果使用单文件组件,你可以注册被导入的.vue文件:

    import MyComponent from './App.vue'
    app.component('MyComponent', MyComponent)
    


    app.component()方法可以被链式调用:

    import { createApp } from 'vue'
    const app = createApp({})
    
    app
      .component('ComponentA', ComponentA)
      .component('ComponentB', ComponentB)
      .component('ComponentC', ComponentC)
    


    全局注册的组件可以在此应用的任意组件的模板中使用:

    <!-- 这在当前应用的任意组件中都可用 -->
    <ComponentA/>
    <ComponentB/>
    <ComponentC/>
    

    所有的子组件,也可以使用全局注册的组件。这意味着这三个组件也都可以在彼此内部使用。


    局部注册

    全局注册的组件虽然十分方便,但也有以下几个短板:

    • 全局注册使构建系统无法移除未使用的组件(也叫“tree-shaking”)。如果你全局注册了一个组件,却一次都没有使用,它仍然会出现在最终的构建产物中。
    • 全局注册在大型项目中使项目的依赖关系变得不那么明确。在父组件中使用子组件时,很难定位子组件的实现。这可能会影响未来长期的可维护性,类似于使用过多的全局变量。

    局部注册将注册组件的可用性限定在当前组件的范围内。它使依赖关系更加明确,并且对 tree-shaking 更加友好。

    当你在单文件组件中使用了<script setup>,导入的组件会自动进行局部注册

    <script setup>
    import ComponentA from './ComponentA.vue'
    </script>
    
    <template>
      <ComponentA />
    </template>
    

    如果不使用<script setup>,你需要使用components选项:

    <script>
    import ComponentA from './ComponentA.js'
    
    export default {
      components: {
        ComponentA
      },
      setup() {
        // ...
      }
    }
    </script>
    

    对于每个components对象里的属性,它们的key名就是注册的组件名,而值就是相应组件的实现。上面的例子中使用的是 ES2015 的缩写语法,等价于:

    <script>
    export default {
      components: {
        ComponentA: ComponentA
      }
      // ...
    }
    </script>
    

    请注意:局部注册的组件,在后代组件中,不可用。在这个例子中,ComponentA注册后,仅在当前组件可用,而在任何的子组件或后代组件中,都不可用。


    组件名格式

    在整个指引中,我们都使用PascalCase作为组件名的注册格式,这是因为:

    • PascalCase是合法的 JavaScript 标识符。这使得在 JavaScript 中导入和注册组件都很容易,同时 IDE 也能提供较好的自动补全。
    • <PascalCase />在模板中更明显地表明了这是一个 Vue 组件,而不是原生 HTML 元素。同时也能够将 Vue 组件和自定义元素(web components)区分开来。

    在单文件组件和内联字符串模板中,我们都推荐这样做。但是,PascalCase的标签名在 DOM 模板中是不可用的,需要使用kebab-case形式。


    幸运的是,Vue 支持将使用kebab-case的标签,解析为使用PascalCase注册的组件。这意味着一个以MyComponent为名注册的组件,在模板中可以通过<MyComponent><my-component>引用。这允许我们在不同来源的模板中始终使用同一份 JavaScript 组件注册代码。

    上篇:组件基础

    下篇:props 数据