Vue 自定义指令

you_De 发布于2019-08-23 13:42 / 1985人阅读

摘要：自定义指令定义直接看官网的介绍吧觉得官方文档说的很清楚了，所以我基本都是抄他的了。除了核心功能默认内置的指令和，也允许注册自定义指令。然而，有的情况下，你仍然需要对普通元素进行底层操作，这时候就会用到自定义指令。

前言最近搞了毕设，需要实现一个场景，点击一块区域，弹出一个编辑区域，点击页面的其他地方的时候，这个编辑区域就隐藏，本想想之前写模态框一样写个方法的时候，突然

觉得可以尝试用 vue 相关的东西优雅的解决这个事情，然后就学了下面的自定义指令了。

1 Vue 自定义指令 1.1 定义

直接看官网的介绍吧（觉得官方文档说的很清楚了，所以我基本都是抄他的了）。

除了核心功能默认内置的指令 (v-model 和 v-show)，Vue 也允许注册自定义指令。注意，在 Vue2.0 中，代码复用和抽象的主要形式是组件。然而，有的情况下，你仍然需要对普通 DOM 元素进行底层操作，这时候就会用到自定义指令。

1.2 基础实现

这个在分两种情况，如果你想定义一个全局的自定义组件的话,那么就在项目中的 main.js 里面定义了，例如定义一个官网中的自动聚焦的指令

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

要是你只是想定义一个局部的指令在某个组件内部用的话，那么就在相应的组件内定义了

// 跟 data(),methods:{} 那些同级写了
directives: {
  focus: {
    // 指令的定义
    inserted: function (el) {
      el.focus()
    }
  }
}

定义完后我们就能愉快的使用了

1.2 钩子函数

当然这个自定义指令不会就这么一点东西啦，为了解决一些现实中场景，Vue 给我们一堆钩子函数用来实现我们的一些骚操作。具体如下 (均为可选)：

bind：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。

inserted：被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)。

update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。

componentUpdated：指令所在组件的 VNode 及其子 VNode 全部更新后调用。

unbind：只调用一次，指令与元素解绑时调用。

接下来我们来看一下钩子函数的参数 (即 el、binding、vnode 和 oldVnode)。

当然要想好好用用这写钩子函数，就要懂得用下面的这些参数

1.3 钩子函数参数

指令钩子函数会被传入以下参数：

el：指令所绑定的元素，可以用来直接操作 DOM 。

binding：一个对象，包含以下属性：

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 }。

vnode：Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。

oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

然后官网有话说

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

然后下面我们给一个简单的例子

// 在组件内部定义一个局部指令
directives:{
  demo:{
    bind: function (el, binding, vnode) {
      var s = JSON.stringify;
      el.innerHTML = 
        `name: ${s(binding.name)} 

        value: ${s(binding.value)} 

        expression: ${s(binding.expression)} 

        argument: ${s(binding.arg)} 

        modifiers: ${s(binding.modifiers)} 

        vnode keys: ${Object.keys(vnode).join(", ")}`
    }
  }
}
 // 绑定到组件中的一个 div 中

然后我们在网页中就可以看到这么一堆文字了(当然下面的注释是我自己写的)

name: "demo" 
// 指定名称
value: "Welcome to Your Vue.js App" 
// 指令绑定值
expression: "message" 
// 字符串形式的指令表达式
argument: "foo" 
// 传给指令的参数
modifiers: {"a":true,"b":true} 
// 修饰符的对象
vnode keys: tag, data, children, text, elm, ns, context, fnContext, fnOptions, fnScopeId, key, componentOptions, componentInstance, parent, raw, isStatic, isRootInsert, isComment, isCloned, isOnce, asyncFactory, asyncMeta, isAsyncPlaceholder
// Vue 编译生成的虚拟节点

1.4 函数简写

在很多时候，你可能想在 bind 和 update 时触发相同行为，而不关心其它的钩子。比如这样写:

colorSwatch: function colorSwitch(el, binding) {
  el.style.backgroundColor = binding.value
},

1.5 对象字面量

如果指令需要多个值，可以传入一个 JavaScript 对象字面量。记住，指令函数能够接受所有合法的 JavaScript 表达式。

Vue.directive("demo", function (el, binding) {
  console.log(binding.value.color) // => "white"
  console.log(binding.value.text)  // => "hello!"
})

就差不多这样吧，想看个实例的话就看一下我的另外一篇笔记《Vue 自定义指令实现点击元素外触发事件》吧

私有云混合云自定义指令自定义指令实例大云软件定义存储支持的指令架构自定义

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/99412.html

每个人都能实现的vue自定义指令

摘要：指令绑定的前一个值，仅在和钩子中可用。字符串形式的指令表达式。上一个虚拟节点在上可根据需要定义一些钩子函数只调用一次，指令第一次绑定到元素时调用。指令的值可能发生了改变，也可能没有。前文先来bb一堆废话哈哈.. 用vue做项目也有一年多了.除了用别人的插件之外.自己也没尝试去封装指令插件之类的东西来用. 刚好最近在项目中遇到一个问题.(快速点击按钮多次触发多...

NickZhou 2019-08-21 18:23 评论0 收藏0
Vue 混合、自定义指令、插件

摘要：当组件和混合对象含有同名选项时，这些选项将以恰当的方式混合自定义指令除了默认设置的核心指令和也允许注册自定义指令。 vue的复用性与组合混合混合 (mixins) 是一种分发 Vue 组件中可复用功能的非常灵活的方式。混合对象可以包含任意组件选项。以组件使用混合对象时，所有混合对象的选项将被混入该组件本身的选项。当组件和混合对象含有同名选项时，这些选项将以恰当的方式混合 ...

whlong 2019-08-21 16:17 评论0 收藏0
使用vue自定义指令开发一个表单验证插件validate.js

摘要：今天就来介绍一下如何利用的自定义指令来开发一个表单验证插件的过程。按照这种方式就能够使用自己开发的这个表单校验插件。这段时间在进行一个新项目的前期搭建，新项目框架采用vue-cli3和typescirpt搭建。因为项目比较轻量，所以基本没有使用额外的ui组件，有时候我们需要的一些基础组件我就直接自己开发了。今天就来介绍一下如何利用vue的自定义指令directive来开发一个表单验证插件的过...

warnerwu 2019-05-23 17:26 评论0 收藏0
vue自定义指令升级2.0的坑

摘要：如今升级后，在自定义指令部分的全部变化了对于一个插件作者来说这简直是崩溃的毫无兼容可言。本文我就讲介绍下一个自定义指令从升级到所走的坑。吐槽我们知道，一个方法最重要的就是传参，所以自定义指令最需要的也是这点。前言从1.0.X版本就开始使用vue了，应该也是vue很早的一批用户。在我司使用vue这一年多以来（偏向移动端），我发现vue的插件真的是少之又少，这也是我当初一开始想写v-...

jokester 2019-08-22 10:43 评论0 收藏0
vue 自定义指令

摘要：添加新指令只需在中加入模块，并引入全局中通过绑定全部指令注册指令业务组件中，加入指令名我们成功完成自定义指令的模块化完整项目地址 vue 自定义指令篇对于vue的指令，有我们熟悉的v-model、v-show等，但我们也可以自己定义我们需要的指令，如比较常用的v-lazy懒加载官方详细文档：https://cn.vuejs.org/v2/guide...通过directive就可以在V...

geekzhou 2019-08-22 16:18 评论0 收藏0