文章詳情頁
vue3自定義插件的作用場景及使用示例詳解
瀏覽:18日期:2022-06-01 13:09:01
目錄
- 插件的作用場景
- 插件的定義(注冊)
- 插件的安裝
- 插件的使用
- 插件中的Provide/inject
插件的作用場景
在vue2的插件那篇文章我們介紹過插件其實就是vue的增強功能。通常來為vue添加全局功能的。在vue3中插件的功能也是一樣的,只是它們在定義上有所不同。
- 通過app.component()和app.directive()注冊一到多個全局組件或自定義指令
- 通過app.provide()使一個資源可被注入進整個應用
- 向app.config.globalProperties中添加一些全局實例屬性或方法
- 一個可能上述三種都包含了的功能庫(如vue-router)
插件的定義(注冊)
一個插件可以是一個擁有 install()
方法的對象,也可以直接是一個安裝函數(shù)本身。安裝函數(shù)會接收到安裝它的應用實例和傳遞給 app.use()
的額外選項作為參數(shù):
下面是我定義的一個插件,為了方便管理,在src目錄下新建一個plugins文件夾,根據(jù)插件的功能,文件夾里面可以放置很多js文件。
export default { install: (app, options) => { // 注入一個全局可用的方法 app.config.globalProperties.$myMethod = () => { console.log("這是插件的全局方法"); } // 添加全局指令 app.directive("my-directive", { bind (el, binding, vnode, oldVnode) { console.log("這是插件的全局指令"); } }) }}
插件的安裝
我們一般是安裝在全局的,這樣方便多個組件使用。
// main.jsimport { createApp } from "vue"import App from "./App.vue"import ElementPlus from "element-plus"import "element-plus/dist/index.css"import myPlugin from "./plugins/myPlugin"createApp(App).use(ElementPlus).use(myPlugin).mount("#app");
插件的使用
在組件中使用
<template> <div v-my-directive></div> <el-button @click="clicFunc">測試按鈕</el-button></template><script setup>import { getCurrentInstance } from "vue";const ctx = getCurrentInstance();console.log("ctx", ctx);const clicFunc = ctx.appContext.app.config.globalProperties.$myMethod();</script>
效果如下:
插件中的Provide/inject
在插件中,還可以通過provide為插件用戶提供一些內(nèi)容,比如像下面這樣,將options參數(shù)再傳給插件用戶,也就是組件中。
// myPlugin.jsexport default { install: (app, options) => { // 注入一個全局可用的方法 app.config.globalProperties.$myMethod = () => { console.log("這是插件的全局方法"); } // 添加全局指令 app.directive("my-directive", { bind () { console.log("這是插件的全局指令"); } }) // 將options傳給插件用戶 app.provide("options", options); }}
// main.jsimport { createApp } from "vue"import App from "./App.vue"import ElementPlus from "element-plus"import "element-plus/dist/index.css"import myPlugin from "./plugins/myPlugin"createApp(App).use(ElementPlus).use(myPlugin, { hello: "你好呀"}).mount("#app");
// 組件中使用<template> <div v-my-directive></div> <el-button @click="clicFunc">測試按鈕</el-button></template><script setup>import { getCurrentInstance, inject } from "vue";const ctx = getCurrentInstance();const hello = inject("options");console.log("hello", hello);const clicFunc = ctx.appContext.app.config.globalProperties.$myMethod();</script>
效果如下:
以上就是vue3自定義插件的作用場景及使用示例詳解的詳細內(nèi)容,更多關(guān)于vue3自定義插件作用的資料請關(guān)注其它相關(guān)文章!
標簽:
JavaScript
排行榜
