vue3全局組件自動注冊功能實現(xiàn)

更新時間：2023年02月01日 15:45:45 作者：風啞

本文主要講述vue3的全局公共組件的自動注冊功能，本文分步驟結合實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友參考下吧

vue3全局組件自動注冊

前言：

本文主要講述vue3的全局公共組件的自動注冊

第一步：建文件

需要在src/components 下創(chuàng)建一個文件夾用于存放封裝的公共組件（這里我起名叫coms）

需要在src/components 下創(chuàng)建一個js文件用于存放引入組件并注冊（這里我起名叫Index.js）

第二步：寫函數(shù)

在coms中建文件夾，將組件放入這個文件夾，此文件夾的名字就是我們將要注冊組件的名字。

在Index.js中寫入以下工具函數(shù)：

// 全局組件注冊 需要到coms這個目錄下注冊
 
export default {
    install(app) {
        const req = require.context('./coms', true, /\.vue$/);
        req.keys().forEach((item) => {
            const defaultObj = req(item).default;
 
            let name = item.split('/')[1];
            // console.log('name', name);
            app.component(name, defaultObj);
        });
    }
};

注意：這里我沒有用 defaultObj.__file 來取文件路徑，是因為生產環(huán)境下__file屬性會被刪除，會導致如下報錯

第三步：導入文件

在main.js中導入工具函數(shù)并掛載到app中

import coms from '@/components/Index'; //全局組件注冊
app.use(coms);

第四步：全局使用

到這一步就可以全局用我們定義好的文件名作為組件名了。

ps：vue2其實也大差不差，就是吧app.use()改成了 Vue.use()

最后感謝大佬的指導 @一個好好的程序員

參考文獻：

vue3全局組件注冊

補充： Vue3注冊全局組件

例如組件使用頻率非常高，幾乎每個頁面都在使用便可以封裝成全局組件

1.注冊單個全局組件

在main.ts 引入我們的組件跟隨在createApp(App) 后面切記不能放到mount 后面這是一個鏈式調用用

其次調用 component 第一個參數(shù)組件名稱第二個參數(shù)組件實例

import { createApp } from 'vue'
import App from './App.vue'
import './assets/css/reset/index.less'
import Card from './components/Card/index.vue'
createApp(App).component('Card',Card).mount('#app') 
//.component('Card',Card)就是注冊全局組件 （‘自定義鍵名'，組件名）

使用方法

直接在其他vue頁面立即使用即可無需引入

<template>
 <Card></Card>
</template>

2.批量注冊全局組件

遇到要注冊很多個全局組件時，可以定義中間件，讓中間件去完成組件注冊，然后main.js再引入使用這個中間件

在src/components中新建index.ts用來將所有需要全局注冊的組件導入

?: 如果使用的是 JS 可以刪除類型校驗

import type { Component } from 'vue' //import type 是用來協(xié)助進行類型檢查和聲明的，在運行時是完全不存在的。

import SvgIcon from './SvgIcon/index.vue'

// ?如果使用的是 JS 可以刪除類型校驗

const components: {

  [propName: string]: Component //字面量類型，每個屬性值類型為組件的類型

} = {

  SvgIcon

}

export default components

2. 在main.ts中導入

?這里使用循環(huán)的方式, 將每個全局組件進行注冊

import { createApp } from 'vue'

import ElementPlus from 'element-plus'

import 'element-plus/dist/index.css' // 基于斷點的隱藏類 Element 額外提供了一系列類名，用于在某些條件下隱藏元素

import App from './App.vue'

import router from './router'

import { store, key } from './store'

import globalComponent from '@/components/index' //引入需要注冊的全部組件

const app = createApp(App)

app.use(store, key).use(router).use(ElementPlus)

// 注冊全局的組件 （對所有需要注冊的組件進行遍歷并注冊）

for (const componentItme in globalComponent) {

  app.component(componentItme, globalComponent[componentItme])

}

app.mount('#app') //需要注冊完組件后才掛載

3. 如果使用TS編寫,還需要在和main.ts同級的目錄, 創(chuàng)建一個components.d.ts, 用來處理組件引入報錯的問題和添加組件類型提示

import SvgIcon from '@/components/SvgIcon/index.vue'

//要擴充@vue/runtime-core包的聲明

declare module '@vue/runtime-core' {

  export interface GlobalComponents { //這里擴充"ComponentCustomProperties"接口

    SvgIcon: typeof SvgIcon

  }

}

4. 最后直接導入即可