目前比较流行的公司网站建站技术,wordpress 下载类型,网站规划与开发专业,南宁世尊商贸网站建设如果您有疑问#xff0c;请观看视频教程《Vue3实战教程》 自定义指令
介绍
除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外#xff0c;Vue 还允许你注册自定义的指令 (Custom Directives)。
我们已经介绍了两种在 Vue 中重用代码的方式#xff1a;组件和组…如果您有疑问请观看视频教程《Vue3实战教程》 自定义指令
介绍
除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外Vue 还允许你注册自定义的指令 (Custom Directives)。
我们已经介绍了两种在 Vue 中重用代码的方式组件和组合式函数。组件是主要的构建模块而组合式函数则侧重于有状态的逻辑。另一方面自定义指令主要是为了重用涉及普通元素的底层 DOM 访问的逻辑。
一个自定义指令由一个包含类似组件生命周期钩子的对象来定义。钩子函数会接收到指令所绑定元素作为其参数。下面是一个自定义指令的例子当 Vue 将元素插入到 DOM 中后该指令会将一个 class 添加到元素中
vue
script setup
// 在模板中启用 v-highlight
const vHighlight {mounted: (el) {el.classList.add(is-highlight)}
}
/scripttemplatep v-highlightThis sentence is important!/p
/template
This sentence is important!
在 script setup 中任何以 v 开头的驼峰式命名的变量都可以当作自定义指令使用。在上述例子中vHighlight 可以在模板中以 v-highlight 的形式使用。
在不使用 script setup 的情况下自定义指令需要通过 directives 选项注册
js
export default {setup() {/*...*/},directives: {// 在模板中启用 v-highlighthighlight: {/* ... */}}
}
将一个自定义指令全局注册到应用层级也是一种常见的做法
js
const app createApp({})// 使 v-highlight 在所有组件中都可用
app.directive(highlight, {/* ... */
})
When to use custom directives
只有当所需功能只能通过直接的 DOM 操作来实现时才应该使用自定义指令。
一个常见例子是使元素获取焦点的 v-focus 指令。
vue
script setup
// 在模板中启用 v-focus
const vFocus {mounted: (el) el.focus()
}
/scripttemplateinput v-focus /
/template
该指令比 autofocus 属性更有用因为它不仅在页面加载时有效而且在 Vue 动态插入元素时也有效
建议尽可能使用 v-bind 等内置指令声明模板因为它们更高效对服务端渲染也更友好。
指令钩子
一个指令的定义对象可以提供几种钩子函数 (都是可选的)
js
const myDirective {// 在绑定元素的 attribute 前// 或事件监听器应用前调用created(el, binding, vnode) {// 下面会介绍各个参数的细节},// 在元素被插入到 DOM 前调用beforeMount(el, binding, vnode) {},// 在绑定元素的父组件// 及他自己的所有子节点都挂载完成后调用mounted(el, binding, vnode) {},// 绑定元素的父组件更新前调用beforeUpdate(el, binding, vnode, prevVnode) {},// 在绑定元素的父组件// 及他自己的所有子节点都更新后调用updated(el, binding, vnode, prevVnode) {},// 绑定元素的父组件卸载前调用beforeUnmount(el, binding, vnode) {},// 绑定元素的父组件卸载后调用unmounted(el, binding, vnode) {}
}
钩子参数
指令的钩子会传递以下几种参数 el指令绑定到的元素。这可以用于直接操作 DOM。 binding一个对象包含以下属性。 value传递给指令的值。例如在 v-my-directive1 1 中值是 2。oldValue之前的值仅在 beforeUpdate 和 updated 中可用。无论值是否更改它都可用。arg传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中参数是 foo。modifiers一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中修饰符对象是 { foo: true, bar: true }。instance使用该指令的组件实例。dir指令的定义对象。 vnode代表绑定元素的底层 VNode。 prevVnode代表之前的渲染中指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。
举例来说像下面这样使用指令
template
div v-example:foo.barbaz
binding 参数会是一个这样的对象
js
{arg: foo,modifiers: { bar: true },value: /* baz 的值 */,oldValue: /* 上一次更新时 baz 的值 */
}
和内置指令类似自定义指令的参数也可以是动态的。举例来说
template
div v-example:[arg]value/div
这里指令的参数会基于组件的 arg 数据属性响应式地更新。
Note
除了 el 外其他参数都是只读的不要更改它们。若你需要在不同的钩子间共享信息推荐通过元素的 dataset attribute 实现。
简化形式
对于自定义指令来说一个很常见的情况是仅仅需要在 mounted 和 updated 上实现相同的行为除此之外并不需要其他钩子。这种情况下我们可以直接用一个函数来定义指令如下所示
template
div v-colorcolor/div
js
app.directive(color, (el, binding) {// 这会在 mounted 和 updated 时都调用el.style.color binding.value
})
对象字面量
如果你的指令需要多个值你可以向它传递一个 JavaScript 对象字面量。别忘了指令也可以接收任何合法的 JavaScript 表达式。
template
div v-demo{ color: white, text: hello! }/div
js
app.directive(demo, (el, binding) {console.log(binding.value.color) // whiteconsole.log(binding.value.text) // hello!
})
在组件上使用
不推荐
不推荐在组件上使用自定义指令。当组件具有多个根节点时可能会出现预期外的行为。
当在组件上使用自定义指令时它会始终应用于组件的根节点和透传 attributes 类似。
template
MyComponent v-demotest /
template
!-- MyComponent 的模板 --div !-- v-demo 指令会被应用在此处 --spanMy component content/span
/div
需要注意的是组件可能含有多个根节点。当应用到一个多根组件时指令将会被忽略且抛出一个警告。和 attribute 不同指令不能通过 v-bind$attrs 来传递给一个不同的元素。
