Vue中自定義指令的三個常用方法小結(jié)
介紹
除了 Vue 內(nèi)置的一系列指令 (比如 v-model 或 v-show) 之外,Vue 還允許你注冊自定義的指令 (Custom Directives)。
我們已經(jīng)介紹了兩種在 Vue 中重用代碼的方式:組件和組合式函數(shù)。組件是主要的構(gòu)建模塊,而組合式函數(shù)則側(cè)重于有狀態(tài)的邏輯。另一方面,自定義指令主要是為了重用涉及普通元素的底層 DOM 訪問的邏輯。
一個自定義指令由一個包含類似組件生命周期鉤子的對象來定義。鉤子函數(shù)會接收到指令所綁定元素作為其參數(shù)。下面是一個自定義指令的例子,當一個 input 元素被 Vue 插入到 DOM 中后,它會被自動聚焦:
<script setup>
// 在模板中啟用 v-focus
const vFocus = {
mounted: (el) => el.focus()
}
</script>
<template>
<input v-focus />
</template>假設(shè)你還未點擊頁面中的其他地方,那么上面這個 input 元素應(yīng)該會被自動聚焦。該指令比 autofocus attribute 更有用,因為它不僅僅可以在頁面加載完成后生效,還可以在 Vue 動態(tài)插入元素后生效。
在 <script setup> 中,任何以 v 開頭的駝峰式命名的變量都可以被用作一個自定義指令。在上面的例子中,vFocus 即可以在模板中以 v-focus 的形式使用。
在沒有使用 <script setup> 的情況下,自定義指令需要通過 directives 選項注冊:
export default {
setup() {
/*...*/
},
directives: {
// 在模板中啟用 v-focus
focus: {
/* ... */
}
}
}
將一個自定義指令全局注冊到應(yīng)用層級也是一種常見的做法:
const app = createApp({})
// 使 v-focus 在所有組件中都可用
app.directive('focus', {
/* ... */
})
創(chuàng)建方法
min.js注冊
import { createApp } from "vue";
import App from "./App.vue";
const app = createApp(App);
app.directive("focus", {
// 在綁定元素的 attribute 前
// 或事件監(jiān)聽器應(yīng)用前調(diào)用
created(el, binding, vnode, prevVnode) {
},
// 在元素被插入到 DOM 前調(diào)用
beforeMount() {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都掛載完成后調(diào)用
mounted() {},
// 綁定元素的父組件更新前調(diào)用
beforeUpdate() {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都更新后調(diào)用
updated() {},
// 綁定元素的父組件卸載前調(diào)用
beforeUnmount() {},
// 綁定元素的父組件卸載后調(diào)用
unmounted() {},
});
app.mount("#app");script setup中使用
<script setup lang="ts">
// 在模板中啟用 v-focus
const vFocus = {
// 在綁定元素的 attribute 前
// 或事件監(jiān)聽器應(yīng)用前調(diào)用
created(el, binding, vnode, prevVnode) {},
// 在元素被插入到 DOM 前調(diào)用
beforeMount() {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都掛載完成后調(diào)用
mounted() {},
// 綁定元素的父組件更新前調(diào)用
beforeUpdate() {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都更新后調(diào)用
updated() {},
// 綁定元素的父組件卸載前調(diào)用
beforeUnmount() {},
// 綁定元素的父組件卸載后調(diào)用
unmounted() {},
};
</script>script中使用
export default {
setup() {
/*...*/
},
directives: {
// 在模板中啟用 v-focus
focus: {
// 在綁定元素的 attribute 前
// 或事件監(jiān)聽器應(yīng)用前調(diào)用
created(el, binding, vnode, prevVnode) {},
// 在元素被插入到 DOM 前調(diào)用
beforeMount() {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都掛載完成后調(diào)用
mounted() {},
// 綁定元素的父組件更新前調(diào)用
beforeUpdate() {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都更新后調(diào)用
updated() {},
// 綁定元素的父組件卸載前調(diào)用
beforeUnmount() {},
// 綁定元素的父組件卸載后調(diào)用
unmounted() {},
}
}
}指令鉤子
一個指令的定義對象可以提供幾種鉤子函數(shù) (都是可選的):
const myDirective = {
// 在綁定元素的 attribute 前
// 或事件監(jiān)聽器應(yīng)用前調(diào)用
created(el, binding, vnode, prevVnode) {
// 下面會介紹各個參數(shù)的細節(jié)
},
// 在元素被插入到 DOM 前調(diào)用
beforeMount(el, binding, vnode, prevVnode) {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都掛載完成后調(diào)用
mounted(el, binding, vnode, prevVnode) {},
// 綁定元素的父組件更新前調(diào)用
beforeUpdate(el, binding, vnode, prevVnode) {},
// 在綁定元素的父組件
// 及他自己的所有子節(jié)點都更新后調(diào)用
updated(el, binding, vnode, prevVnode) {},
// 綁定元素的父組件卸載前調(diào)用
beforeUnmount(el, binding, vnode, prevVnode) {},
// 綁定元素的父組件卸載后調(diào)用
unmounted(el, binding, vnode, prevVnode) {}
}鉤子參數(shù)
指令的鉤子會傳遞以下幾種參數(shù):
el:指令綁定到的元素。這可以用于直接操作 DOM。
binding:一個對象,包含以下屬性。
- value:傳遞給指令的值。例如在 v-my-directive="1 + 1" 中,值是 2。
- oldValue:之前的值,僅在 beforeUpdate 和 updated 中可用。無論值是否更改,它都可用。
- arg:傳遞給指令的參數(shù) (如果有的話)。例如在 v-my-directive:foo 中,參數(shù)是 "foo"。
- modifiers:一個包含修飾符的對象 (如果有的話)。例如在 v-my-directive.foo.bar 中,修飾符對象是 { foo: true, bar: true }。
- instance:使用該指令的組件實例。
- dir:指令的定義對象。
vnode:代表綁定元素的底層 VNode。
prevNode:代表之前的渲染中指令所綁定元素的 VNode。僅在 beforeUpdate 和 updated 鉤子中可用。
舉例來說,像下面這樣使用指令:
<div v-example:foo.bar="baz">
binding 參數(shù)會是一個這樣的對象:
{
arg: 'foo',
modifiers: { bar: true },
value: /* `baz` 的值 */,
oldValue: /* 上一次更新時 `baz` 的值 */
}
和內(nèi)置指令類似,自定義指令的參數(shù)也可以是動態(tài)的。舉例來說:
<div v-example:[arg]="value"></div>
這里指令的參數(shù)會基于組件的 arg 數(shù)據(jù)屬性響應(yīng)式地更新。
除了 el 外,其他參數(shù)都是只讀的,不要更改它們。若你需要在不同的鉤子間共享信息,推薦通過元素的 dataset attribute 實現(xiàn)。
簡化形式
對于自定義指令來說,一個很常見的情況是僅僅需要在 mounted 和 updated 上實現(xiàn)相同的行為,除此之外并不需要其他鉤子。這種情況下我們可以直接用一個函數(shù)來定義指令,如下所示:
<div v-color="color"></div>
app.directive('color', (el, binding) => {
// 這會在 `mounted` 和 `updated` 時都調(diào)用
el.style.color = binding.value
})
對象字面量
如果你的指令需要多個值,你可以向它傳遞一個 JavaScript 對象字面量。別忘了,指令也可以接收任何合法的 JavaScript 表達式。
<div v-demo="{ color: 'white', text: 'hello!' }"></div>
app.directive('demo', (el, binding) => {
console.log(binding.value.color) // => "white"
console.log(binding.value.text) // => "hello!"
})
在組件上使用
當在組件上使用自定義指令時,它會始終應(yīng)用于組件的根節(jié)點,和透傳 attributes 類似。
<MyComponent v-demo="test" /> <!-- MyComponent 的模板 --> <div> <!-- v-demo 指令會被應(yīng)用在此處 --> <span>My component content</span> </div>
需要注意的是組件可能含有多個根節(jié)點。當應(yīng)用到一個多根組件時,指令將會被忽略且拋出一個警告。和 attribute 不同,指令不能通過 v-bind="$attrs" 來傳遞給一個不同的元素。總的來說,不推薦在組件上使用自定義指令。
以上就是Vue中自定義指令的三個常用方法小結(jié)的詳細內(nèi)容,更多關(guān)于Vue自定義指令的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
關(guān)于Python正則表達式 findall函數(shù)問題詳解
在寫正則表達式的時候總會遇到不少的問題,本文講述了Python正則表達式中 findall()函數(shù)和多個表達式元組相遇的時候會出現(xiàn)的問題2018-03-03
使用Pygal庫創(chuàng)建可縮放的矢量圖表的操作方法
在本文中,我們探討了如何使用Pygal庫創(chuàng)建可縮放的矢量圖表,首先,我們介紹了Pygal的基本概念和安裝方法,然后通過多個示例演示了如何創(chuàng)建各種類型的圖表,包括折線圖、柱狀圖、餅圖、散點圖、雷達圖和地圖等,需要的朋友可以參考下2024-05-05
Python利用docx模塊實現(xiàn)快速操作word文件
這篇文章主要為大家詳細介紹了Python如何利用docx模塊實現(xiàn)快速操作word文件,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2022-09-09
淺析如何在Python中使用結(jié)構(gòu)模式匹配
在Python 3.10中引入了模式匹配語法,允許我們在應(yīng)用程序中使用強大的新編程技術(shù)進行決策,下面我們就來講講如何在Python中使用結(jié)構(gòu)模式匹配吧2023-08-08
PySpark與GraphFrames的安裝與使用環(huán)境搭建過程
這篇文章主要介紹了PySpark與GraphFrames的安裝與使用教程,本文通過圖文并茂實例代碼相結(jié)合給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-02-02

