Vue3.0 如何写自定义指令

背景

问:什么是指令?

答:指令就是DOM与逻辑行为的媒介,本质就是DOM绑定的独立逻辑行为函数。除了核心功能默认内置的指令 (例如 v-model 和 v-show ),Vue 也允许注册自定义指令。Vue自定义指令和组件一样存在着全局注册和局部注册两种方式。先来看看注册全局指令的方式,通过 Vue.directive( id, [definition] ) 方式注册全局指令,第一个参数为自定义指令名称(指令名称不需要加 v- 前缀,默认是自动加上前缀的,使用指令的时候一定要加上前缀),第二个参数可以是对象数据,也可以是一个指令函数。

在 Vue 中,代码复用和抽象的主要形式是组件。本文介绍的就是Vue3.0之后我们该如何应用这指令呢。

Vue3.0钩子函数

01

**created:**在绑定元素的 attribute 或事件监听器被应用之前调用。在指令需要附加需要在普通的 v-on 事件监听器前调用的事件监听器时,这很有用

02

**beforeMount:**当指令第一次绑定到元素并且在挂载父组件之前调用

03

**mounted:**在绑定元素的父组件被挂载后调用

04

**beforeUpdate:**在更新包含组件的 VNode 之前调用

05

**pdated:**在包含组件的 VNode 及其子组件的 VNode 更新后调用

06

**beforeUnmount:**在卸载绑定元素的父组件之前调用

07

**unmounted:**当指令与元素解除绑定且父组件已卸载时,只调用一次

目标

抛开技术领域的探索,对于项目,我们要达成的目标是什么呢?

试想,有这样的一些需求:

①. 一个最简单的表单中,需要用户对某些内容复制,比方说版本号及一些订单编号及个人信息。

**②. **用户点击其他位置需要将此弹窗隐藏。

③. 自定聚焦到表单处。

④. 防止按钮在短时间内被多次点击,使用防抖函数限制规定时间内只能点击一次。

实现

import Directives from "@/Directives/index";// 自定义指令(@ 代表src)
const app = createApp(App);
app.use(Directives);
app.mount("#app");

  1. index.js内容 copy为例
import copy from "./copy"; // 引入需要的指令
import clickoutside from "./clickoutside";
import focus from "./focus";
import debounce from "./debounce"

const directivesList = {
  copy, // 挂载
  clickoutside,
};

const directives = {
  install: function (app) {
    Object.keys(directivesList).forEach((key) => {
      app.directive(key, directivesList[key]); // 注册
    });
  }
};

export default directives;// 抛出

import { ElMessage } from "element-plus";  //复制
const copy = {
  mounted (el, { value }) {
    el.$value = value;
    el.handler = () => {
      if (!el.$value) {
        // 值为空的时候,给出提示
        ElMessage.warning({
          message: "您好,复制的值不能为空。",
          type: "warning"
        });
        return;
      }
      if (window.clipboardData) {
        window.clipboardData.setData("text", el.$value);
      } else {
        (function (content) {
          document.oncopy = function (e) {
            e.clipboardData.setData("text", content);
            e.preventDefault();
            document.oncopy = null;
          };
        })(el.$value);
        document.execCommand("Copy");
      }

      ElMessage.success("复制成功");
    };
    // 绑定点击事件
    el.addEventListener("click", el.handler);
  },
  beforeUpdate (el, {
    value
  }) {
    el.$value = value;
  },
  unmounted (el) {
    el.removeEventListener("click", el.handler);
  }
};

export default copy;

const clickoutside = {
  // 初始化指令
  beforeMount (el, binding, vnode) {
    function documentHandler (e) {
    //   // 这里判断点击的元素是否是本身,是本身,则返回
      if (el.contains(e.target)) {
        return false;
      }
      //   // 判断指令中是否绑定了函数
      if (binding.value.name) {
        // 如果绑定了函数 则调用那个函数,此处binding.value就是handleClose方法
        binding.value(e);
      }
    }
    // // 给当前元素绑定个私有变量,方便在unbind中可以解除事件监听
    el.__vueClickOutside__ = documentHandler;
    document.addEventListener("click", documentHandler);
  },
  beforeUnmount (el, binding) {
    // 解除事件监听
    document.removeEventListener("click", el.__vueClickOutside__);
    delete el.__vueClickOutside__;
  }
};

export default clickoutside;

# 页面input自动聚焦
const focus = {
  mounted (el) {
    el.querySelector("input").focus();
  }
};

export default focus;

# 定义一个延迟执行的方法,如果在延迟时间内再调用该方法,则重新计算执行时间。  


const debounce = {
  inserted: function (el, binding) {
    let timer
    el.addEventListener('keyup', () => {
      if (timer) {
        clearTimeout(timer)
      }
      timer = setTimeout(() => {
        binding.value()
      }, 1000)
    })
  },
}

export default debounce

总结

自定义指令的第二用处是用于集成第三方插件。我们知道任何软件开发领域都可以分为四层:底层是原生的API,上层是通用框架,再上层是通用组件,最上层才是具体的业务代码。一个通用框架,必须搭配一套完整的通用组件,才能真正奠定其江湖地位。

在前端开发领域,以前的通用框架是jQuery,jQuery以及基于jQuery构建的通用组件形成了一个庞大的生产系统。现在的通用框架是Angular、React和Vue,每个框架都需要基于自身构建新的组件库。自定义指令好就好在:原先的那些通用组件,无论是纯js的也好,基于jQuery的也好,都可以拿来主义直接吸收,而不需要改造或重构。

比如写文档通常会用到focus.js,我们可以直接将其封装为一个自定义指令,这样focus.js就变成了Vue的一个新功能。

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Vue.js中,自定义指令是用于扩展模板语法的一种方式。它允许开发者在DOM元素上添加一些特定的行为或交互逻辑。引用中提到,Vue2和Vue3的自定义指令参数是一样的,包括el、binding、vnode和preVNode(oldVNode),这些参数用于指令的操作和交互。具体的用法可以查看官方文档。 然而,Vue2和Vue3在自定义指令的注册方式上有一些区别。在Vue2中,我们使用Vue.directive()方法来注册全局自定义指令,或者在组件中使用directives选项来注册局部自定义指令。而在Vue3中,我们使用app.directive()方法来注册全局自定义指令,或者在组件的setup()函数中使用directive()方法来注册局部自定义指令。这是因为Vue3将全局API移动到了应用实例(app)上,以提高代码的可读性和维护性。引用提供的例子展示了Vue2和Vue3中注册自定义指令的区别。 总结来说,Vue2和Vue3的自定义指令在参数方面是一样的,但在注册方式上有一些区别。Vue2使用Vue.directive()来注册全局和局部自定义指令,而Vue3则使用app.directive()来注册全局自定义指令,或者在组件的setup()函数中使用directive()来注册局部自定义指令。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [vue2和vue3自定义指令区别?](https://blog.csdn.net/m0_53273062/article/details/126201620)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 50%"] - *2* *3* [vue2.0和vue3.0中自定义指令(directive)的区别](https://blog.csdn.net/m0_46846526/article/details/118911913)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值