palantir/blueprint

useHotkeys stopPropagation is called on the native event instead of the synthetic one

Open

#6028 opened on Mar 17, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P2Package: coreType: bughelp wanted

Description

Environment

  • Package version(s): 4.17.6
  • Operating System: 13.2.1 (22D68)
  • Browser name and version: Version 111.0.5563.64 (Official Build) (arm64)

Code Sandbox

Link to a minimal repro: https://codesandbox.io/s/serverless-rgb-cmsi5j

Steps to reproduce

  1. Focus the input group.
  2. Press w.
  3. Look at the console and notice how the parent component's onKeyDown handler is still called despite setting stopPropagation: true on the hotkey.

Actual behavior

The parent onKeyDown handler was called.

Expected behavior

The parent onKeyDown handler shouldn't have been called.

Possible solution

stopPropagation should be called on React's synthetic event instead of the browser's native one because React uses event delegation and registers all handlers on the root node. Issue can be found here.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue is in the useHotkeys hook, specifically in the stopPropagation call at line 113 of packages/core/src/hooks/hotkeys/useHotkeys.ts. Instead of calling e.nativeEvent.stopPropagation(), it should call e.stopPropagation() on the React synthetic event. The codesandbox provided can be used to verify the fix. No other discussions or PRs linked.