Vue3 編寫自定義指令插件的示例代碼

// src/plugins/directive.ts
import type { App } from 'vue'
// 插件選項的類型
interface Options {
  // 文本高亮選項
  highlight?: {
    // 默認背景色
    backgroundColor: string
  }
}
/**
 * 自定義指令
 * @description 保證插件單一職責，當前插件隻用於添加自定義指令
 */
export default {
  install: (app: App, options?: Options) => {
    /**
     * 權限控制
     * @description 用於在功能按鈕上綁定權限，沒權限時會銷毀或隱藏對應 DOM 節點
     * @tips 指令傳入的值是管理員的組別 id
     * @example <div v-permission="1" />
     */
    app.directive('permission', (el, binding) => {
      // 假設 1 是管理員組別的 id ，則無需處理
      if (binding.value === 1) return
      // 其他情況認為沒有權限，需要隱藏掉界面上的 DOM 元素
      if (el.parentNode) {
        el.parentNode.removeChild(el)
      } else {
        el.style.display = 'none'
      }
    })
    /**
     * 文本高亮
     * @description 用於給指定的 DOM 節點添加背景色，搭配文本內容形成高亮效果
     * @tips 指令傳入的值需要是合法的 CSS 顏色名稱或者 Hex 值
     * @example <div v-highlight="`cyan`" />
     */
    app.directive('highlight', (el, binding) => {
      // 獲取默認顏色
      let defaultColor = 'unset'
      if (
        Object.prototype.toString.call(options) === '[object Object]' &&
        options?.highlight?.backgroundColor
      ) {
        defaultColor = options.highlight.backgroundColor
      }
      // 設置背景色
      el.style.backgroundColor =
        typeof binding.value === 'string' ? binding.value : defaultColor
    })
  },
}

// src/main.ts
import { createApp } from 'vue'
import App from '@/App.vue'
import directive from '@/plugins/directive' // 導入插件
createApp(App)
   // 自定義插件
  .use(directive, {
    highlight: {
      backgroundColor: '#ddd',
    },
  })
  .mount('#app')

<template>
  <!-- 測試 permission 指令 -->
  <div>根據 permission 指令的判斷規則：</div>
  <div v-permission="1">這個可以顯示</div>
  <div v-permission="2">這個沒有權限，會被隱藏</div>
  <!-- 測試 permission 指令 -->

  <!-- 測試 highlight 指令 -->
  <div>根據 highlight 指令的判斷規則：</div>
  <div v-highlight="`cyan`">這個是青色高亮</div>
  <div v-highlight="`yellow`">這個是黃色高亮</div>
  <div v-highlight="`red`">這個是紅色高亮</div>
  <div v-highlight>這個是使用插件初始化時設置的灰色</div>
  <!-- 測試 highlight 指令 -->
</template>