写一个自定义指令,之前用的少,遇见了,在这里记录一下,嘻嘻~~
一、什么是指令
在vue中定义了很多指令。比如v-model数据双向绑定,v-bind属性动态绑定指令,v-on添加事件的指令,v-text,给标签添加普通文本,v-html添加到标签属性中,以富文本的方式,解释并渲染输出富文本数据,v-once数据只进行一次渲染,修改后显示页不变,v-show条件渲染指令,用于控制是否显示标签,v-if条件渲染指令,用于控制是否显示标签,v-for列表渲染指令,用于循环遍历序列数据等。
但是这些指令都是vue中自带的,当这些不满足我们使用的时候,可以通过自定义指令来完成我们不能满足的需求!!
二、自定义指令
指令的定义分为全局指令定义和组件内指令定义,全局指令的定义可以用在整个项目中的任何组件,一般会定义在一个JS模块中,然后在main.js中引入。
定义全局指令
Vue.directive(指令名,指令对象)
// 定义一个v-test指令(定义的时候不加v-,使用的时候必须要加上),完成测试功能,弹出一段话
Vue.directive('test',{
// 自定义指令钩子函数,是一个可选的,
bind(el, binding, vnode){ //常用
alert('bind()钩子函数,指令第一次绑定到元素上时调用,只调用一次,可以执行初始化操作');
},
inserted(el, binding, vnode){
alert('inserted()钩子函数,指令所绑定的元素插入到DOM中时调用');
},
update(el, binding, vnode){
alert('update()钩子函数,被绑定元素所在模板更新时调用');
},
componentUpdated(el, binding, vnode){
alert('componentUpdated()钩子函数被,绑定元素所在模板完成一次更新周期时调用');
},
unbind(el, binding, vnode){
alert('unbind()钩子函数,指令与元素解绑时调用,只执行一次');
}
})
组件内自定义指令
在vue的脚手架中,添加了directive选项,可以直接在这里定定义自定义组件
directives:{
指令名:{
指令对象
}
}
directives:{
test:{
// 自定义指令钩子函数,是一个可选的,
bind(el, binding, vnode){ //常用
alert('bind()钩子函数,指令第一次绑定到元素上时调用,只调用一次,可以执行初始化操作');
},
inserted(el, binding, vnode){
alert('inserted()钩子函数,指令所绑定的元素插入到DOM中时调用');
},
update(el, binding, vnode){
alert('update()钩子函数,被绑定元素所在模板更新时调用');
},
componentUpdated(el, binding, vnode){
alert('componentUpdated()钩子函数被,绑定元素所在模板完成一次更新周期时调用');
},
unbind(el, binding, vnode){
alert('unbind()钩子函数,指令与元素解绑时调用,只执行一次');
}
}
}
三、自定义指令生命周期函数
一个指令定义对象可以提供如下几个钩子函数 (均为可选):
- bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
- inserted:被绑定元素插入父节点时调用(仅保证父节点存在,但不一定已被插入文档中)。
- update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新
- componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
- unbind:只调用一次,指令与元素解绑时调用。
四、参数介绍
自定义指令的生命周期钩子函数会被传入以下参数:
- el:指令所绑定的元素,就是该指令使用的位置所在的节点。
- 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 编译生成的虚拟节点。
- oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。
六、下边用一个例子进行说明
例子来源于官网
Vue.directive('demo', {
bind: function (el, binding, vnode) {
var s = JSON.stringify
el.innerHTML =
'name: ' + s(binding.name) + '<br>' +
'value: ' + s(binding.value) + '<br>' +
'expression: ' + s(binding.expression) + '<br>' +
'argument: ' + s(binding.arg) + '<br>' +
'modifiers: ' + s(binding.modifiers) + '<br>' +
'vnode keys: ' + Object.keys(vnode).join(', ')
}
})
new Vue({
el: '#hook-arguments-example',
data: {
message: 'hello!'
}
})
输出结果
这是在vue中进行自定义的指令具体方法,可以根据自己在写的过程中进行总结一些比较实用的自定义指令。下边推荐几个~~~
6个实用的Vue自定义指令推荐
详细内容查看官网:https://v2.cn.vuejs.org/v2/guide/custom-directive.html