facebookarchive/draft-js

onEscape is deprecated but keyBindingFn does not catch Escape key

Open

#1839 opened on Aug 17, 2018

View on GitHub
 (3 comments) (0 reactions) (1 assignee)JavaScript (22,554 stars) (2,646 forks)batch import
documentationhelp wanted

Description

Do you want to request a feature or report a bug? Bug

What is the current behavior? keyBindingFn does not catch Escape key

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. You can use this jsfiddle to get started: https://jsfiddle.net/stopachka/m6z0xn4r/. https://codesandbox.io/s/6jw8mzxl3n

What is the expected behavior? keyBindingFn should catch Escape key OR onEscape should not trigger a deprecation warning OR there should be an alternative way of catching Escape key

Which versions of Draft.js, and which browser / OS are affected by this issue? Did this work in previous versions of Draft.js? Draft.js 0.10.5

Contributor guide

Tech stack
javascriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Basic understanding of ReactFamiliarity with Draft.js editor architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the handling of Escape key in Draft.js. Look at the keyBindingFn implementation in `src/component/handlers/edit/keyBindingFn.js` and compare with the deprecated onEscape prop. Determine why keyBindingFn does not catch Escape key and propose a fix. Note that the repository is archived, so contributions may not be merged.