自定义指令

最新推荐文章于 2025-06-14 19:15:41 发布

你真好看l

最新推荐文章于 2025-06-14 19:15:41 发布

阅读量287

点赞数

CC 4.0 BY-SA版权

分类专栏： vue的学习

本文链接：https://blog.youkuaiyun.com/qq_40052011/article/details/102633135

vue的学习专栏收录该内容

22 篇文章

订阅专栏

本文深入探讨Vue中的自定义指令，介绍如何注册和使用自定义指令，包括全局和局部指令的定义方式。同时，提供了钩子函数的详细解释及其参数说明，展示了动态指令参数的应用示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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


<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>自定义指令</title>
		<!--
		1.注册全局指令
		Vue.directive('my-directive',function(el,binding){
			el.innerHTML = binding.value.toUpperCase();
			
		})
		2.注册局部指令
		directive:{
			'myDirective': {
				bind(el, binding){
					el.innerHTML = binding.value.toUpperCase();
				}
			}
		}
		3.使用指令
		v-my-directive='xxx'
		-->
	</head>
	<body>
		
		<!--
		需求：自定义两个指令
		1.功能类型于v-text,但转换为全大写， v-upper-text
		2.功能类型于v-text，但转换为全小写 v-lower-text
		-->
		<div id="test">
			<p v-upper-text="msg1"></p>
			<p v-lower-text="msg1"></p>
		</div>
		<div id="test1">
			<p v-upper-text="msg1"></p>
			<p v-lower-text="msg2"></p><!--局部指令不可用，只在vm管理内有效-->
		</div>
		<script src="vue.js" type="text/javascript" charset="utf-8"></script>
		<script type="text/javascript">
			//定义全局指令
			Vue.directive('upper-text',function(el,binding){//el:指令属性所在得标签对象,binding包含指令相关信息数据的对象
				el.textContent = binding.value.toUpperCase();
			})
			new Vue({
				el: "#test",
				data:{
					msg1: "Just Do It!"
				},
				directives:{//注册局部指令,只在当前vm管理内有效
					'lower-text':function(el,binding){//可以写成es6写法'lower-text'(el,binding){}
						el.textContent = binding.value.toLowerCase();
						
					}
				}
			})
			new Vue({
				el: "#test1",
				data:{
					msg1: "Just Do It!"
				},
			
			})
		</script>
	</body>
</html>

钩子函数
一个指令定义对象可以提供如下几个钩子函数 (均为可选)：

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

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

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

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

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 编译生成的虚拟节点。
oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
除了 el 之外，其它参数都应该是只读的，切勿进行修改。如果需要在钩子之间共享数据，建议通过元素的 dataset 来进行。

这是一个使用了这些属性的自定义钩子样例：

<div id="hook-arguments-example" v-demo:foo.a.b="message"></div>
Vue.directive('demo', {
  bind: function (el, binding, vnode) {
    var s = JSON.stringify
    el.innerHTML =
      'name: '       + s(binding.name) + '<br>' +
      'value: '      + s(binding.value) + '<br>' +
      'expression: ' + s(binding.expression) + '<br>' +
      'argument: '   + s(binding.arg) + '<br>' +
      'modifiers: '  + s(binding.modifiers) + '<br>' +
      'vnode keys: ' + Object.keys(vnode).join(', ')
  }
})

new Vue({
  el: '#hook-arguments-example',
  data: {
    message: 'hello!'
  }
})

在这里插入图片描述
动态指令参数
指令的参数可以是动态的。例如，在 v-mydirective:[argument]=“value” 中，argument 参数可以根据组件实例数据进行更新！这使得自定义指令可以在应用中被灵活使用。

例如你想要创建一个自定义指令，用来通过固定布局将元素固定在页面上。我们可以像这样创建一个通过指令值来更新竖直位置像素值的自定义指令：

<div id="baseexample">
  <p>Scroll down the page</p>
  <p v-pin="200">Stick me 200px from the top of the page</p>
</div>
Vue.directive('pin', {
  bind: function (el, binding, vnode) {
    el.style.position = 'fixed'
    el.style.top = binding.value + 'px'
  }
})

new Vue({
  el: '#baseexample'
})

这会把该元素固定在距离页面顶部 200 像素的位置。但如果场景是我们需要把元素固定在左侧而不是顶部又该怎么办呢？这时使用动态参数就可以非常方便地根据每个组件实例来进行更新。

<div id="dynamicexample">
  <h3>Scroll down inside this section ↓</h3>
  <p v-pin:[direction]="200">I am pinned onto the page at 200px to the left.</p>
</div>
Vue.directive('pin', {
  bind: function (el, binding, vnode) {
    el.style.position = 'fixed'
    var s = (binding.arg == 'left' ? 'left' : 'top')
    el.style[s] = binding.value + 'px'
  }
})

new Vue({
  el: '#dynamicexample',
  data: function () {
    return {
      direction: 'left'
    }
  }
})

在这里插入图片描述
函数简写
在很多时候，你可能想在 bind 和 update 时触发相同行为，而不关心其它的钩子。比如这样写:

Vue.directive(‘color-swatch’, function (el, binding) {
el.style.backgroundColor = binding.value
})
对象字面量
如果指令需要多个值，可以传入一个 JavaScript 对象字面量。记住，指令函数能够接受所有合法的 JavaScript 表达式。

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