vue 自定义指令v-xx

240 阅读3分钟

vue 指令:以v-xx开头的行内属性

不同指令实现不同的功能

除了核心功能默认内置的指令 (v-model 和 v-show), Vue 也允许注册自定义指令

  • v-model
  • v-bind
  • v-show
  • v-if

指令的5种使用方式:

//会实例化一个指令,但这个指令没有参数 
`v-xxx`

// -- 将值传到指令中  // 下面自定义的v-copy就是使用的这种方式
`v-xxx="value"`  

// -- 将字符串传入到指令中,如`v-html="'<p>内容</p>'"`
`v-xxx="'string'"` 

// -- 传参数(`arg`),如`v-bind:class="className"`
`v-xxx:arg="value"` 

// -- 使用修饰符(`modifier`)
`v-xxx:arg.modifier="value"` 

注册自定义指令的两种方法:

全局注册 Vue.directive()


// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
  // 当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
    // 聚焦元素
    el.focus()  // 页面加载完成之后自动让输入框获取到焦点的小功能
  }
})

局部注册

  • v-focus
  • v-copy
<template>
    <div class="box">
        <input type="text" v-focus>
        <span class="copy-text" v-copy="text">{{ text }}</span>
    </div>

</template>
<script>
export default {
    //  局部注册 自定义指令
    directives: {
        focus: {
            inserted: function (el, binding) {
                el.focus() // 页面加载完成之后自动让输入框获取到焦点的小功能
            }
        },
        copy: {
            bind(el, binding) {
                console.log(el, binding)
                const { value } = binding;
                el.$value = value;
                el.handler = () => {
                    if (!el.$value) {
                        console.warn('无复制内容');
                        return;
                    }
                    // 动态创建 textarea 标签
                    const textarea = document.createElement('textarea');
                    textarea.readOnly = 'readonly';
                    textarea.style.position = 'absolute';
                    textarea.style.left = '-9999px';
                    textarea.value = el.$value;
                    document.body.appendChild(textarea);
                    textarea.select();
                    const result = document.execCommand('Copy');
                    if (result) {
                        alert('复制成功');
                    }
                    document.body.removeChild(textarea);
                }
                el.addEventListener('click', el.handler);
            },
            unbind() {
                el.removeEventListener('click', el.handler);
            },
            // 当传进来的值更新的时候触发
            componentUpdated(el, { value }) {
                el.$value = value;
            }

        }

    },
    data() {
        return {
            text:"我是一段要被复制的文本"
        }
    }
}

</script>

API:

自定义指令也像组件那样存在钩子函数:

  • 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 }
  • vnodeVue 编译生成的虚拟节点

  • oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用

除了 el 之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行