遇到 React 事件对象如何用TypeScript定义

在React组件开发过程中,频繁地在DOM元素上绑定合成事件是一种常见的实践。例如,在div元素上添加onClick事件处理器,或者在input元素上添加onChange事件处理器,都是为了响应用户的交互行为。这些合成事件处理器接收一个特别的React事件对象,该对象提供了事件的详细信息,使得开发者能够根据事件的具体情况执行相应的逻辑。

然而,在使用TypeScript进行React开发时,正确地定义这个事件对象的类型可能会遇到一些挑战。很多开发者可能会选择使用any类型来定义事件对象,以避免类型错误。但这种做法牺牲了TypeScript提供的类型安全性,可能会隐藏潜在的错误,如下列代码所示:

tsx 复制代码
import React from 'react';
import type { FC } from 'react';

const MyComponent: FC = () => {
  const handleClick = (event: any) => {
    console.log('Button clicked!');
    console.log('Event type:', event.type);
    console.log('Target element:', event.target);
  };

  return (
    <button onClick={handleClick}>Click me!</button>
  );
};

export default MyComponent;

幸运的是,@types/react包提供了一套丰富的DOM事件泛型类型,它们能够帮助我们更精确地定义事件对象的类型。这不仅能够提高代码的类型安全性,还能够让我们更加自信地访问事件对象中的属性和方法。以下是一些常用的 DOM 事件泛型类型列表及其描述:

事件类型 描述
AnimationEvent CSS动画。
ChangeEvent 改变<input><select><textarea>元素的值。
ClipboardEvent 使用复制、粘贴和剪切事件。
CompositionEvent 由于用户间接输入文本而发生的事件(例如,根据浏览器和PC设置,如果您想在美国键盘上输入日文,可能会出现一个带有附加字符的弹出窗口)。
DragEvent 使用指针设备(例如,鼠标)进行拖放交互。
FocusEvent 元素获得或失去焦点时发生的事件。
FormEvent 每当表单或表单元素获得/失去焦点、表单元素值更改或表单提交时发生的事件。
InvalidEvent 当输入的有效性限制失败时触发(例如<input type="number" max="10">,有人插入数字20)。
KeyboardEvent 用户与键盘的交互。每个事件描述单个键的交互。
MouseEvent 由于用户与指针设备(例如,鼠标)的交互而发生的事件。
PointerEvent 由于用户与多种指针设备(如鼠标、笔/触控笔、触摸屏)的交互而发生的事件,它还支持多点触控。除非您为较旧的浏览器(IE10或Safari 12)开发,否则建议使用指针事件。扩展UIEvent
TouchEvent 由于用户与触摸设备的交互而发生的事件。扩展UIEvent。
TransitionEvent CSS过渡。浏览器支持不完全。扩展UIEvent。
UIEvent 鼠标、触摸和指针事件的基本事件。
WheelEvent 在鼠标滚轮或类似输入设备上滚动。(注意:wheel事件不应与scroll事件混淆)
SyntheticEvent 所有上述事件的基本事件。在不确定事件类型时应使用。

在上述代码中,由于用户的操作是点击按钮,因此应当使用 MouseEvent 类型。而且,因为事件的目标是一个 button 元素,所以 MouseEvent 泛型应当具体化为 HTMLButtonElement,也就是其泛型变量应该是 HTMLButtonElementHTMLButtonElement 是 TypeScript 中一个内置 HTML 元素接口。

以下是一些常用的 HTML 元素接口列表及其描述:

HTML 元素接口 描述
HTMLInputElement 代表 <input> 元素,包含特定的属性,如 valuecheckedtype 等。
HTMLSelectElement 代表 <select> 元素,包含 optionslengthselectedIndex 等属性。
HTMLAnchorElement 代表 <a>(锚)元素,包括 hreftargetdownload 等属性。
HTMLTextAreaElement 代表 <textarea> 元素,提供 rowscolsvalue 等属性。
HTMLDivElement 代表 <textarea> 元素,提供 rowscolsvalue 等属性。
HTMLImageElement 代表 <img> 元素,包含 srcaltwidthheight 等属性。
diff 复制代码
import React from 'react';

const MyComponent: React.FC = () => {
- const handleClick = (event: any) => {
+ const handleClick = (event: React.MouseEvent<HTMLButtonElement>) => {
    console.log('Button clicked!');
    console.log('Event type:', event.type);
    console.log('Target element:', event.currentTarget); // 使用currentTarget而不是target,以确保类型的正确性
  };

  return (
    <button onClick={handleClick}>Click me!</button>
  );
};

export default MyComponent;

在上述代码示例中,我们使用了React.MouseEvent<HTMLButtonElement>来定义handleClick函数的event参数。这表明我们期望这个事件是一个鼠标事件,且事件的目标是一个HTML按钮元素。这种明确的类型定义使得我们能够安全地访问event.currentTarget中的属性,例如typecurrentTarget,而无需担心类型错误。

相关推荐
牧码岛8 分钟前
Web前端之Vue+Element打印时输入值没有及时更新dom的问题
前端·javascript·html·web·web前端
小二李14 分钟前
第8章 Node框架实战篇 - 文件上传与管理
前端·javascript·数据库
HIT_Weston31 分钟前
45、【Ubuntu】【Gitlab】拉出内网 Web 服务:http.server 分析(二)
前端·http·gitlab
十一.3661 小时前
79-82 call和apply,arguments,Date对象,Math
开发语言·前端·javascript
霍格沃兹测试开发学社-小明1 小时前
测试左移2.0:在开发周期前端筑起质量防线
前端·javascript·网络·人工智能·测试工具·easyui
用户99045017780091 小时前
若依工作流-包含网关
前端
遇到困难睡大觉哈哈1 小时前
Harmonny os——《从 TypeScript 到 ArkTS 的适配规则》精简笔记
笔记·typescript·harmonyos·鸿蒙
by__csdn1 小时前
Vue 中计算属性、监听属性与函数方法的区别详解
前端·javascript·vue.js·typescript·vue·css3·html5
on_pluto_2 小时前
【debug】关于如何让电脑里面的两个cuda共存
linux·服务器·前端
r***F2622 小时前
Go-Gin Web 框架完整教程
前端·golang·gin