vue自定义指令

AngularJS的启发,Vue内置了一些非常有用的指令,比如v-htmlv-once等,每个指令都有自身的用途。除了系统内部的指令,Vue也允许注册自定义指令。

一、自定义指令的注册

全局引入

创建一个directive.js,代码如下,然后在main.js中引入即可。

// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
    // 当被绑定的元素插入到 DOM 中时
    inserted: function (el) {
        el.focus()
    }
})

这里有个函数简写形式,想在bindupdate时触发相同行为,而不关心其它的钩子。可以这样写:

Vue.directive('focus', function (el, binding) {
    el.focus();
})
局部引入

如果想注册局部指令,组件中也接受一个 directives 的选项:

directives: {
    focus: {
        inserted: function (el) {
            el.focus();
        }
    }
}

然后就可以在模板中任何元素上使用新的v-focus属性,如下:

<input v-focus>

二、参数

自定义指令一共有5个钩子函数:bindinsertedupdatecomponentUpdateunbind
钩子函数会被传入以下参数:elbindingvnodeoldVnode
以上内容详细可以参考官网对钩子函数的简介——钩子函数 。不过有点非常重要的就是除了 el 之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。

三、举例说明

指令的使用方式主要是以下四种:

  • v-once,什么都不传递。
  • v-text='"test"',把我们需要传递的值放在=号后面传递过去。
  • v-on:click="handClick" ,为指令传递参数click
  • v-on:click.stop="handClick" ,为指令添加一个修饰符。
场景一: 限制输入框输入的最大长度(不包含空格)

指令名为limit,指令的绑定值为可输入最大长度。

//template
<input v-limit="20"/>

//directive.js
Vue.directive('limit', function (el, binding, vnode) {
    el.addEventListener("input", function () {
        if(el.type !== 'text')return;
        el.value = el.value.replace(" ","");
        if(el.value.length>binding.value)el.value = el.value.slice(0,binding.value);
    });
});
场景二:通过指令实现防抖

指令名为debounce,传给指令的参数为clickclick作为参数传入的目的在于可以配置事件,通过传keydownmouseover等也可以让这个指令支持鼠标或者键盘事件等等。而修饰符.stop或者.prevent可以配置事件冒泡和阻止默认事件等等。

//template
<div v-debounce:click.stop.prevent="clickFn"></div>

//directive.js
Vue.directive('debounce', function (el, binding) {
    let timer;
    el.addEventListener(binding.arg, () => {
        if (binding.modifiers.stop) event.stopPropagation();
        if (binding.modifiers.prevent) event.preventDefault();
        if (timer) clearTimeout(timer);
        timer = setTimeout(() => {
            binding.value();
        }, 300);
    });
});

以上是两个简单的例子,会发现用的最频繁的是elbindingel表示元素本身,binding比较复杂了,它有以下属性:

  • binding.name 指令名。比如例子中的v-debounce中的debounce
  • binding.value 绑定的指令的值。比如v-debounce:click="clickFn"中的clickFn
  • binding.arg 传给指令的参数。比如v-debounce:click="clickFn"v-debounce:后面的click
  • binding.modifiers 一个包含修饰符的对象。比如v-debounce:click.stop.prevent中,修饰符对象为{ stop: true, prevent: true }
  • binding.expression 字符串形式的指令表达式。比如v-debounce:click="clickFn"中的"clickFn"
  • binding.oldValue 指令绑定的前一个值,仅在updatecomponentUpdated钩子中可用。无论值是否改变都可用。

binding.valuebinding.expression可能会搞乱,binding.value获取的是具体的方法或者数值,而binding.expression获取的仅仅是方法名和值的表达式,举个例子:

//template
<div v-test="1+1"></div>

//directive.js
Vue.directive('test', function (el, binding) {
    console.log(binding.value); //2
    console.log(binding.expression); //1+1
});

四、干货分享

总的来说,指令是非常强大的,但是往往也很容易被开发者们所忽略,因为很多时候用工具类函数或者组件的方式也可以实现同样的功能,不过学会指令的话肯定就是如虎添翼,作为一个有要求的程序员,还是非常有必要掌握这个技能,分享个干货,这15个Vue自定义指令,让你的项目开发爽到爆

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

推荐阅读更多精彩内容