在 Vue2.0 中,代码复用和抽象的主要形式是组件。然而,有的情况下,你仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。
你可以将一些 css 样式抽象到指令中,也可以将一些 js 操作放到指令中去执行。就使用上来说,指令不用像组件一样需要引入和注册,注册后使用非常简洁方便。
第一部分:常用指令
一、if指令
v-if:
v-else-if:
v-else:
<div class="home">
<div v-if="sex==0">女</div>
<div v-else-if="sex==1">男</div>
<div v-else>保密</div>
</div>
二、 v-show:
<button @click="play">按钮</button>
<div class="box" v-show="ss">
<ul>
<li>111</li>
<li>222</li>
<li>333</li>
</ul>
</div>
三、v-html 与 v-text
<div class="box" v-html="ss"></div>
<div class="box" v-text="ss"></div>
四、v-for:
<div class="box" v-for="item in arr" :key="item.id">
{{item}}
</div>
<div class="box" v-for="item in num" :key="item">
{{item}}
</div>
五、v-once:
<span v-once>This will never change: {{msg}}</span>
六:v-bind: 绑定属性 简写 :绑定的属性
style:
<div v-bind:style="{border:'1px solid #f00',height:num+'px'}" ></div>
<div :style="{border:'1px solid #f00',height:num+'px'}" ></div>
class:
<div :class="['box',lan?'fblue':'','fborder']" ></div>
<div class="box fborder" :class="{'fblue':isblue}"></div>
七、v-on:触发事件 触发事件绑定 简写 @触发事件
<!-- 阻止单击事件继续传播 -->
<a v-on:click.stop="doThis"></a>
<!-- 提交事件不再重载页面 -->
<form v-on:submit.prevent="onSubmit"></form>
<!-- 修饰符可以串联 -->
<a v-on:click.stop.prevent="doThat"></a>
<!-- 只有修饰符 -->
<form v-on:submit.prevent></form>
<!-- 添加事件监听器时使用事件捕获模式 -->
<!-- 即内部元素触发的事件先在此处理,然后才交由内部元素进行处理 -->
<div v-on:click.capture="doThis">...</div>
<!-- 只当在 event.target 是当前元素自身时触发处理函数 -->
<!-- 即事件不是从内部元素触发的 -->
<div v-on:click.self="doThat">...</div>
八、v-model 特殊的v-bind 用于表单控件绑定value的
<input type="text" v-model="str">
第二部分:实用指令大全
对于在项目中常用到的指令,在此做了一个合集介绍。
元素点击范围扩展指令 v-expandClick
使用该指令可以隐式的扩展元素的点击范围,由于借用伪元素实现,故不会影响元素在页面上的排列布局。
可传入的参数为:上右下左扩展的范围,单位 px,默认向外扩展 10px。
文本内容复制指令 v-copy
使用该指令可以复制元素的文本内容(指令支持单击复制 v-copy、双击复制 v-copy.dblclick、点击icon复制 v-copy.icon 三种模式),不传参数时,默认使用单击复制。
元素全屏指令 v-screenfull
全屏指令,点击元素进行全屏/退出全屏的操作。支持元素后面是否插入 element-ui 的全屏图标 el-icon-full-screen。
元素说明指令 v-tooltip
为元素添加说明,如同 element-ui 的 el-tooltip(问号 icon 在鼠标覆盖后,展示说明文字)。
文字超出省略指令 v-ellipsis
使用该指令当文字内容超出宽度(默认 100 px)时自动变为省略形式。等同于使用 css:
width: 100px;
whiteSpace: nowrap
overflow: hidden;
textOverflow: ellipsis;
回到顶部指令 v-backtop
使用该指令可以让页面或指定元素回到顶部。
可选指定元素,如果不指定则全局页面回到顶部。可选在元素偏移多少 px 后显示 backtop 元素;还可以在模板中任何元素上使用新的元素 v-backtop property。
也可以这样使用,表示为一直显示绑定指令的元素,并且是全局页面回到顶部:
回到顶部
空状态指令 v-empty
使用该指令可以显示缺省的空状态。 可以传入默认图片(可选,默认无图片)、默认文字内容(可选,默认为暂无数据)、以及标示是否显示空状态(必选)。
徽标指令 v-badge
使用该指令在元素右上角显示徽标。
支持配置徽标的背景颜色、徽标形状;支持传入徽标上显示的数字。
拖拽指令 v-drag
使用该指令可以对元素进行拖拽。
响应缩放指令 v-resize
使用该指令可以响应元素宽高改变时执行的方法。
如何使用这些指令?
为了便于管理指令,我们将每个指令都存在于单独的 js 文件中,你可以像这样将指令 import 进来后注册指令:
或者你可以直接使用 Vue.deirect 进行注册。
第三 部分:自定义指令
除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令。有的情况下,对普通 DOM 元素进行底层操作,这时候就会用到自定义指令 下面定义了一个v-test指令绑定数据name
<template> <div class="hello"> <div v-test='name'></div> </div> </template> <script> export default { data () { return { name:'我是名字', } }, directives:{ test:{ inserted: function (el,binding) {// 指令的定义 / /el为绑定元素,可以对其进行dom操作 console.log(binding) //一个对象,包含很多属性属性 }, bind: function (el, binding, vnode) { el.innerHTML =binding.value } } }, created:function(){ }, mounted:function(){ }, methods:{ } } </script>
第三部分:自定义指令介绍
除了核心功能默认内置的指令 (v-model
和 v-show
),Vue 也允许注册自定义指令。注意,在 Vue2.0 中,代码复用和抽象的主要形式是组件。然而,有的情况下,你仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。
钩子函数
一个指令定义对象可以提供如下几个钩子函数 (均为可选):
-
bind
:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。 -
inserted
:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。 -
update
:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
-
componentUpdated
:指令所在组件的 VNode 及其子 VNode 全部更新后调用。 -
unbind
:只调用一次,指令与元素解绑时调用。
接下来我们来看一下钩子函数的参数 (即 el
、binding
、vnode
和 oldVnode
)。
钩子函数参数
指令钩子函数会被传入以下参数:
-
el
:指令所绑定的元素,可以用来直接操作 DOM。 -
binding
:一个对象,包含以下 property:
-
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
来进行。
这是一个使用了这些 property 的自定义钩子样例:
<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!'
}
})
name: "demo" value: "hello!" 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
动态指令参数
指令的参数可以是动态的。例如,在 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'
}
}
})
第四部分:局部自定义指令:
html:
//修改input框内的背景色
<input type="text" v-myfocus>
export default {
el:'app',
directives:{
myfocus:{
inserted (el,binding) {
console.log(el);
console.log(binding);
el.style.backgroundColor = '#ccc';
}
}
},
}
第四部分:全局自定义指令
html:
<input type="text" v-mycolor="color">
省略
export default {
el:‘app’,
data(){
return {
//定义颜色
color:'red'
}
}
}
在main.js中定义全局自定义指令
`把所有的main.js都贴了出来```
//import Vue from 'vue';
import App from './App.vue';
import router from './router';
Vue.use(ElementUI);
* 自定义指令 有用的只有下面这个
* mycolor 是自定义name,把它放到html中,
Vue.directive('mycolor',{
inserted (el,binding) {
//这里我使用了binding,所以要在使用到的组件
//内部,定义一个color,才能显示
el.style.color = binding.value;
}
})
// Vue.use(echarts);
new Vue({
router,
store,
render: h => h(App)
}).$mount('#app');
` input 内部的标识已经变成红色