React useKeyPress 钩子

Beginner

This tutorial is from open-source community. Access the source code

简介

在本实验中,我们将学习如何创建一个名为 useKeyPress 的自定义 React 钩子,它会监听给定按键按下状态的变化。在需要检测用户是否按下特定按键的场景中,这个钩子会很有用。我们将分别使用 useStateuseEffect 钩子来处理状态和事件监听器。

React useKeyPress 钩子

虚拟机中已提供 index.htmlscript.js。一般来说,你只需在 script.jsstyle.css 中添加代码。

此函数监听给定按键按下状态的变化。使用方法如下:

  • 以目标按键作为参数调用 useKeyPress()
  • useKeyPress() 返回一个布尔值,指示该按键当前是否被按下。
  • 该函数使用 useState() 钩子创建一个状态变量,用于保存给定按键的按下状态。
  • 它定义了两个处理函数,分别在按键按下或松开时更新状态变量。
  • useEffect() 钩子和 EventTarget.addEventListener() 用于处理 'keydown''keyup' 事件。
  • 最后,EventTarget.removeEventListener() 用于在组件卸载后执行清理操作。
const useKeyPress = (targetKey) => {
  const [isKeyPressed, setKeyPressed] = React.useState(false);

  const handleKeyDown = ({ key }) => {
    if (key === targetKey) setKeyPressed(true);
  };

  const handleKeyUp = ({ key }) => {
    if (key === targetKey) setKeyPressed(false);
  };

  React.useEffect(() => {
    window.addEventListener("keydown", handleKeyDown);
    window.addEventListener("keyup", handleKeyUp);

    return () => {
      window.removeEventListener("keydown", handleKeyDown);
      window.removeEventListener("keyup", handleKeyUp);
    };
  }, [targetKey]);

  return isKeyPressed;
};

以下是 useKeyPress() 在 React 组件中的一个使用示例:

const MyApp = () => {
  const isWKeyPressed = useKeyPress("w");

  return <p>The "w" key is {!isWKeyPressed ? "not " : ""}pressed!</p>;
};

ReactDOM.render(<MyApp />, document.getElementById("root"));

请点击右下角的“Go Live”以在端口 8080 上运行网络服务。然后,你可以刷新“Web 8080”标签页来预览网页。

总结

恭喜你!你已经完成了 React useKeyPress 钩子实验。你可以在 LabEx 中练习更多实验来提升你的技能。