vue 自定义指令

此处使用原官网的栗子

在自定义组件中,而并非全局注册的自定义指令

<template>
    <div>
        <input type="text" v-focus v-model="input">
    </div>
</template>
<script>
    export default {
        data() {
            return {
                input: ''
            }
        },
        directives: {
            focus: {
                // 指令的定义
                bind(el, binding, vnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log('只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置')
                },
                inserted(el, binding, vnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log('被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。')
                    el.focus()
                },
                update(el, binding, vnode, oldVnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log(oldVnode, '---oldVnode')
                    // 所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新
                    window.console.log('所在组件的 VNode 更新时调用')
                },
                componentUpdated(el, binding, vnode, oldVnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log(oldVnode, '---oldVnode')
                    window.console.log('指令所在组件的 VNode 及其子 VNode 全部更新后调用。')
                },
                unbind(el, binding, vnode) {
                    window.console.log('只调用一次,指令与元素解绑时调用。')
                }
            }
        }
    }
</script>
image.png

组件更新时触发update和componentUpdated两个钩子函数


image.png

钩子函数参数

  • el:指令所绑定的元素,可以用来直接操作 DOM 。
  • binding:一个对象,包含以下属性:
    • name:指令名,不包括 v- 前缀。
    • value:指令的绑定值,例如:v-my-directive="1 + 1" 中,绑定值为 2
    • oldValue:指令绑定的前一个值,仅在 updatecomponentUpdated 钩子中可用。无论值是否改变都可用。
    • 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:上一个虚拟节点,仅在 updatecomponentUpdated 钩子中可用。

展开详细说一下binding对象中的属性

<template>
    <div>
        --原生仅有一个单独的指令--
        <input type="text" v-focus v-model="input1">
        --给指令绑定了值,并且包含一个修饰符--
        <input type="text" v-focus.name="'指令绑定的值'" v-model="input2">
        --给自定义指令传递参数--
        <input type="text" v-focus:args v-model="input3">
    </div>
</template>

<script>
    export default {
        data() {
            return {
                header: '来自子组件的头部消息',
                input1: '',
                input2: '',
                input3: ''
            }
        },
        directives: {
            focus: {
                // 指令的定义
                bind(el, binding, vnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log('只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置')
                },
                inserted(el, binding, vnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log('被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。')
                    el.focus()
                },
                update(el, binding, vnode, oldVnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log(oldVnode, '---oldVnode')
                    // 所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新
                    window.console.log('所在组件的 VNode 更新时调用')
                },
                componentUpdated(el, binding, vnode, oldVnode) {
                    window.console.group('-----------------------------------------------------------')
                    window.console.log(el, '---el')
                    window.console.log(binding, '---binding')
                    window.console.log(vnode, '---vnode')
                    window.console.log(oldVnode, '---oldVnode')
                    window.console.log('指令所在组件的 VNode 及其子 VNode 全部更新后调用。')
                },
                unbind(el, binding, vnode) {
                    window.console.log('只调用一次,指令与元素解绑时调用。')
                }
            }
        }
    }
</script>
image.png

image.png

对应红框中的内容
{
name: 自定义组件的名称,
expression:字符串形式的指令表达式(例如 v-my-directive="1 + 1"中,表达式为 "1 + 1"。),
modifiers:包含修饰符的对象(v-focus.name),
value:给自定义指令绑定的值(v-focus="'指令绑定的值'"),
rawName:未加工过的名称(指令在使用时的样子),
arg: 传给指令的参数
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350