vue3自定义指令详解

vue3中自定义指令的简单案例

官方文档中给了一个很简单的示例,官方文档地址:自定义指令

const app = Vue.createApp({})

// 注册一个全局自定义指令 `v-focus`

app.directive('focus', { 

    // 当被绑定的元素挂载到 DOM 中时…… 

    mounted(el) {    // 聚焦元素   

        el.focus() 

    }

})

然后给了一个使用示例:

<input v-focus />

示例非常简单,按照官方的说明写下这个案例后也能够正常运行。但实际使用肯定不止于此,我们必然会遇到需要传递参数的需求,而且官方文档后面又提到可以给自定义指令传递值和参数,并且给出了一个公式说明:

v-mydirective:[argument]="value"

这里面的argument和value可以通过钩子函数中的binding参数获取到具体就是binding.value可以获取到自定义指令中的value,binding.arg可以获取到指令的动态参数argument。

<input v-focus[direction]="demo" />

我觉得按照官方文档上的介绍那我应该能得到binding.value是demo,binding.arg是direction,但实际我得到了两个undefined。我以为我应该是传递了两个字符串,这里其实没注意到vue的指令中我这样写实际是传递了一个需要在组件的data中定义的变量。也就是我必须在setup中定义出来这两个变量:

<script setup>

    let direction = 'right'

    let demo = 'demoStr'

</script>

这样我在自定义指令的钩子函数中就可以得到正确的结果:

app.directive('focus', {

    mounted(el, binding){

        console.log(binding.value) //这里打印出demoStr

        console.log(binding.arg) //这里打印出right

        el.focus()

    }

})

这里再看上面官方给的公式

v-mydirective:[argument]="value"

这里面的argument和value实际是需要你定义的两个变量,可以接受的值也是可以多种类型的,基本类型或者对象字面量都可以。

<input v-focus[12]="23" />  // binding.value是23,binding.arg是12,数字类型

<input v-focus[true]="false" /> // binding.value是false,binding.arg是true,布尔类型

<input v-focus[direction]="demo" /> //这里binding.value是{valueStr: 'demoStr'}, binding.arg是{direction:'right'}

//setup中定义对象

<script setup> 

  let direction = {

        direction:'right'

    }

  let demo = {

        valueStr: 'demoStr'

    }

</script>

//这里也可以使用对象字面量,而不是setup中定义变量

<input v-focus[{direction: 'right'}]="{valueStr: 'demoStr'}" />

自定义指令在组件中使用

比如我们想在elment-plus的组件上使用自定义指令,类似下面这样:

<el-input v-focus:[direction]="pinPadding" ></el-input>

这里的el-input是element-plus提供的组件,它会被渲染成<div>包裹<input>的结构。

这个时候,自定义指令总是会被应用在组件的根节点上,这个时候我们获取input这个节点的方式就会有变化:

app.directive('focus', {

   mounted(el, binding){

        let subNode = el.getElementsByTagName('input')[0] 

        subNode.focus()

   }

})

同时官方还给出一个注意点:当被应用在一个多根节点的组件上时,指令会被忽略,并且会抛出一个警告。

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

推荐阅读更多精彩内容