文档
- https://v2.cn.vuejs.org/v2/guide/custom-directive.html
目录
- 简介
- 钩子函数
- 函数参数
- 基本使用
- 传递参数
- 传递变量
- 绑定方法
- 更多实例
简介
官方文档提到:
对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。
钩子函数
一个指令定义对象可以提供如下几个钩子函数 (均为可选):
- bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
- inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。
- update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
- componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
- unbind:只调用一次,指令与元素解绑时调用。
函数参数
- 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 钩子中可用。
基本使用
以下示例,都会在页面显示Hello
字符串
自定义指令 directive.js
const customDirective = {
bind: function (el, binding, vnode) {
el.innerHTML = 'Hello'
},
}
使用自定义指令
<!-- 引入Vue 2.7.14 -->
<!-- <script src="https://cdn.jsdelivr.net/npm/vue@2.7.14/dist/vue.js"></script> -->
<script src="./vue@2.7.14.js"></script>
<!-- 引入自定义指令 -->
<script src="./directive.js"></script>
<!-- Vue节点 -->
<div id="app">
<div v-custom></div>
</div>
<!-- 逻辑 -->
<script>
// 注册指令
Vue.directive('custom', customDirective)
// 创建Vue实例
const app = new Vue({
el: '#app',
// 数据
data() {
return {}
},
// 方法
methods: {},
})
</script>
传递参数
const customDirective = {
bind: function (el, binding, vnode) {
el.innerHTML = binding.arg
},
}
<div v-custom:Hello></div>
传递变量
<!-- Vue节点 -->
<div id="app">
<div v-custom:[name]></div>
</div>
<!-- 逻辑 -->
<script>
// 创建Vue实例
const app = new Vue({
el: '#app',
// 数据
data() {
return {
name: 'Hello'
}
},
})
</script>
绑定方法
const customDirective = {
bind: function (el, binding, vnode) {
el.innerHTML = binding.value()
},
}
<!-- Vue节点 -->
<div id="app">
<div v-custom="handleBind"></div>
</div>
<!-- 逻辑 -->
<script>
// 创建Vue实例
const app = new Vue({
el: '#app',
// 数据
data() {
return {
name: 'Hello',
}
},
// 方法
methods: {
handleBind() {
return this.name
},
},
})
</script>
注意
如果直接调用方法,会在绑定事件前,直接调用该方法
<div v-custom="handleBind()"></div>
更多实例
- js:Vue.js自定义指令实现scroll下滑滚动翻页
- Vue2.js:v-click-outside自定义指令和vue-click-outside监听鼠标点击元素外部区域事件
- vue.js:使用自定义指令监听元素尺寸变化(宽度、高度)
- Vue.directive指令实现按钮级别权限控制