先看一下官网定义:
除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令。注意,在 Vue2.0 中,代码复用和抽象的主要形式是组件。然而,有的情况下,你仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。
官网实现聚焦指令:
// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
以上最基础的例子。
钩子函数
bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。
update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
unbind:只调用一次,指令与元素解绑时调用。
语法:
Vue.directive(‘my-directive’, {
bind: function(el, binding, vnode) {
// 指令第一次绑定到元素时调用
},
inserted: function(el, binding, vnode) {
// 元素插入到DOM中时调用
},
update: function(el, binding, vnode, oldVnode) {
// 元素更新时调用
},
componentUpdated: function(el, binding, vnode, oldVnode) {
// 指令所在组件的VNode及其子VNode全部更新后调用
},
unbind: function(el, binding, vnode) {
// 指令与元素解绑时调用
}
})
第一个参数是指令的名称
第二个参数是一个对象,包含了各个钩子函数。在钩子函数中,可以通过参数 来获取元素、绑定值、VNode等信息,从而实现各种功能。
钩子函数参数
-
el:指令所绑定的元素,可以用来直接操作 DOM。
-
binding:一个对象,包含以下 property:
name:指令名,不包括 v- 前缀。 value:指令的绑定值,例如:v-my-directive="1 + 1" 中,绑定值为 2。 oldValue:指令绑定的前一个值,仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。 expression:字符串形式的指令表达式。例如 v-my-directive="1 + 1" 中,表达式为 "1 + 1"。 arg:传给指令的参数,可选。例如 v-my-directive:foo 中,参数为 "foo"。 modifiers:一个包含修饰符的对象。例如:v-my-directive.foo.bar 中,修饰符对象为 { foo: true, bar: true }。
-
vnode:Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
-
oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。
常见场景:
v-permission:实现后台按钮权限,只有当用户具有某个权限时才能点击该按钮
v-focus:实现自动获取焦点,在表单中,当用户打开页面时,让输入框自动获取焦点。
v-lazy:实现图片懒加载,在图片较多的页面中,可以使用图片懒加载,优化页面性能。
v-debounce:实现防抖,在搜索框中,当用户输入时,避免多次发送请求,提高搜索效率。
v-throttle:实现节流,在滚动加载中,避免用户快速滚动时多次触发加载事件,影响用户体验。
v-scroll:实现滚动加载,在长列表中,当用户滚动到底部时,自动加载更多数据。
v-tooltip:实现提示框,在需要提示信息的元素中,当用户鼠标移动到元素上时,自动显示提示信息。
v-clipboard:实现剪贴板功能,当用户点击元素时,自动将文本复制到剪贴板中。
v-ellipsis:实现文本溢出省略号,当文本过长时,自动省略文本并显示省略号。
v-mask:实现输入框掩码,在需要限制用户输入内容的输入框中,可以使用掩码功能,限制用户输入的内容。
例如:permission
Vue.directive(‘permission’, {
inserted: function(el, binding) {
// 获取按钮需要的权限
const { value: permission } = binding;
// 判断用户是否具有该权限
const hasPermission = checkPermission(permission);
// 如果用户没有该权限,则禁用按钮
if (!hasPermission) {
el.disabled = true;
}
}
})
编辑
参考了文章:
原文链接:https://blog.csdn.net/Q_v3_v2/article/details/129853022