[vue3进阶] 9.自定义指令

我们之前用过很多vue自带的指令了,比如v-if、v-show、v-html、v-model,其实我们也可以自己定义指令。

在vue中大部分功能都能通过数据驱动的方式来完成,我们只要控制数据,而不用去操作dom,但是有一些功能是数据驱动无法控制到的,比如我们之前说过的滚动、让输入框聚焦等等,这时候我们就又需要去操作dom了,自定义指令就派上了用场

咱们先来看一个vue官网的例子,让输入框在页面加载完成后获得焦点
我们写directive的还有一个原因就是为了方便复用,所以我们来定义全局directive

在main.js中,使用根vue对象来创建指令,那么在我们整个的项目都可以使用它

import { createApp } from 'vue'
import App from './App19.vue'

// 获取到createApp创建的全局vue对象
const app = createApp(App)

// 调用vue的directive方法来定义一个指令
app.directive('focus', {
  mounted(el) {
    // el就是获取到的dom元素
    el.focus()
  },
})

app.mount('#app')

用directive方法来定义一个指令
第一个参数:指令的名字,使用时候前面要加上v-,比如这里名字叫做focus,使用的时候要写成v-focus
第二个参数:是一个对象,里面写了mounted回调函数,跟我们之前写的mounted一样,表示这个元素挂载时,调用这个方法,它的第一个参数el,表示有这个指令的那个dom对象,
我们看一下怎么使用就知道了

<template>
  <div>
    <input type="text" v-focus />
  </div>
</template>

<script>
// directives
export default {
  name: 'App',
  data() {
    return {}
  },
}
</script>

<style></style>

这段代码只有一个地方需要注意一下,就是我们指令的使用

<input type="text" v-focus />

1.使用时v-加上指令的名字,这里是v-focus
2.在定义指令时,mounted回调函数,具体到这个例子中就是input标签在挂载到页面上以后,自动调用的
3.mounted回调函数的第一个参数el,就是这个input的dom对象,我们直接调用了它的focus方法,所以它就得到了焦点


我们再来写一个常用的例子,比如在后台管理的项目中,每个人都有不同的权限,权限不同,能看到的内容也不同,
现在有一个删除按钮,它对应的权限是‘del’,有这个权限的人才能看到这个按钮,没有权限的人就看不到

我们这个指令名字叫hasPermi,从vue-element-admin学过来的
这次我们先写这个指令的使用

<button v-hasPermi="'del'">删除按钮</button>

表示有del权限的人,才能看到删除按钮

这个指令是这么写的

app.directive('hasPermi', {
  mounted(el, binding) {
    const permission = binding.value // 获取到指令绑定的值
    const myPermission = ['add', 'update', 'del'] // 当前登录人的权限列表,这里模拟一下,写死了
    if (!myPermission.includes(permission)) {
      // 判断如果当前登录人没有这个元素绑定的权限,就把这个元素移除,所以没有权限的人就看不到这个内容了
      el.parentNode && el.parentNode.removeChild(el)
    }
  },
})

这个例子的重点在于,回调函数的第二个参数binding,在binding的value里我们拿到了在使用指令时给它的值

v-hasPermi="'del'"

这里传给的是一个字符串,所以del用单引号包了起来

除了我们使用的mounted回调函数,还有很多其他的,就不一一介绍了

binding里还可以获取其他参数也不介绍了,一大堆看一遍也记不住,需要写directive时,大家再去官网查api就行了

下面我们来说重要的是,把代码写得优雅一点
现在,我们把指令都写在了main.js里面,显得main.js内容很乱,我们就要整理整理了


首先在src文件夹下建立一个directives文件夹,把我们的指令都放这里面
focus.js

export const focus = {
  mounted(el) {
    // el就是获取到的dom元素
    el.focus()
  },
}

hasPermi.js

export const hasPermi = {
  mounted(el, binding) {
    const permission = binding.value // 获取到指令绑定的值
    const myPermission = ['add', 'update', 'del'] // 当前登录人的权限列表,这里模拟一下,写死了
    if (!myPermission.includes(permission)) {
      // 判断如果当前登录人没有这个元素绑定的权限,就把这个元素移除,所以没有权限的人就看不到这个内容了
      el.parentNode && el.parentNode.removeChild(el)
    }
  },
}

然后在directives文件夹下再建立一个index.js,来统一导出这些文件
index.js

export * from './focus'
export * from './hasPermi'

最后在main.js里使用

import { createApp } from 'vue'
import App from './App19.vue'
import * as directives from './directives' // 把所有的directive都引入进来

const app = createApp(App)
console.log(directives)
// 利用循环把他们都添加到vue实例中
Object.keys(directives).forEach((key) => {
  app.directive(key, directives[key])
})

app.mount('#app')

这样就完成了,使用时候还是一样的
还是那句话记住api不重要,重要的是我们要理解directive是干什么用的,最后用比较优雅的方式把代码组织起来。

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

推荐阅读更多精彩内容