Skip to content
← Back to rules

unicorn/prefer-keyboard-event-key Style

🛠️ An auto-fix is available for this rule.

作用

强制使用 KeyboardEvent#key 而不是 KeyboardEvent#keyCode, 因为后者已被弃用。

.key 属性也更具语义性,并且更易读。

为什么这不好?

keyCodewhichcharCode 属性已被弃用, 应当避免使用,转而使用 key 属性。

示例

以下是此规则的错误代码示例:

js
window.addEventListener("keydown", (event) => {
  if (event.keyCode === 8) {
    console.log("Backspace 被按下了");
  }
});

window.addEventListener("keydown", (event) => {
  console.log(event.keyCode);
});

以下是此规则的正确代码示例:

js
window.addEventListener("keydown", (event) => {
  if (event.key === "Backspace") {
    console.log("Backspace 被按下了");
  }
});

window.addEventListener("click", (event) => {
  console.log(event.key);
});

如何使用

To enable this rule using the config file or in the CLI, you can use:

json
{
  "rules": {
    "unicorn/prefer-keyboard-event-key": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "unicorn/prefer-keyboard-event-key": "error",
  },
});
bash
oxlint --deny unicorn/prefer-keyboard-event-key

版本

此规则添加于 v1.33.0。

参考资料