From aa4945b4453e0eacf09a3652abb4c08ef7c2350a Mon Sep 17 00:00:00 2001
From: Thomas A Caswell <tcaswell@gmail.com>
Date: Wed, 17 Mar 2021 18:32:44 -0400
Subject: [PATCH] FIX: port the key handling changes from mpl

ports changes from matplotlib/matplotlib#19146

closes #309
---
 ipympl/backend_nbagg.py | 63 +++++++++++++++++++++++++++++++++++++++++
 js/src/mpl_widget.js    | 20 ++++++-------
 2 files changed, 71 insertions(+), 12 deletions(-)

diff --git a/ipympl/backend_nbagg.py b/ipympl/backend_nbagg.py
index 99e12a87..469d8494 100644
--- a/ipympl/backend_nbagg.py
+++ b/ipympl/backend_nbagg.py
@@ -12,6 +12,7 @@
     default
 )
 
+import matplotlib
 from matplotlib import rcParams
 from matplotlib.figure import Figure
 from matplotlib import is_interactive
@@ -241,6 +242,68 @@ def send_binary(self, data):
     def new_timer(self, *args, **kwargs):
         return TimerTornado(*args, **kwargs)
 
+    if matplotlib.__version__ < '3.4':
+        # backport the Python side changes to match the js changes
+        def _handle_key(self, event):
+            _SPECIAL_KEYS_LUT = {'Alt': 'alt',
+                                 'AltGraph': 'alt',
+                                 'CapsLock': 'caps_lock',
+                                 'Control': 'control',
+                                 'Meta': 'meta',
+                                 'NumLock': 'num_lock',
+                                 'ScrollLock': 'scroll_lock',
+                                 'Shift': 'shift',
+                                 'Super': 'super',
+                                 'Enter': 'enter',
+                                 'Tab': 'tab',
+                                 'ArrowDown': 'down',
+                                 'ArrowLeft': 'left',
+                                 'ArrowRight': 'right',
+                                 'ArrowUp': 'up',
+                                 'End': 'end',
+                                 'Home': 'home',
+                                 'PageDown': 'pagedown',
+                                 'PageUp': 'pageup',
+                                 'Backspace': 'backspace',
+                                 'Delete': 'delete',
+                                 'Insert': 'insert',
+                                 'Escape': 'escape',
+                                 'Pause': 'pause',
+                                 'Select': 'select',
+                                 'Dead': 'dead',
+                                 'F1': 'f1',
+                                 'F2': 'f2',
+                                 'F3': 'f3',
+                                 'F4': 'f4',
+                                 'F5': 'f5',
+                                 'F6': 'f6',
+                                 'F7': 'f7',
+                                 'F8': 'f8',
+                                 'F9': 'f9',
+                                 'F10': 'f10',
+                                 'F11': 'f11',
+                                 'F12': 'f12'}
+
+            def handle_key(key):
+                """Handle key values"""
+                value = key[key.index('k') + 1:]
+                if 'shift+' in key:
+                    if len(value) == 1:
+                        key = key.replace('shift+', '')
+                if value in _SPECIAL_KEYS_LUT:
+                    value = _SPECIAL_KEYS_LUT[value]
+                key = key[:key.index('k')] + value
+                return key
+
+            key = handle_key(event['key'])
+            e_type = event['type']
+            guiEvent = event.get('guiEvent', None)
+            if e_type == 'key_press':
+                self.key_press_event(key, guiEvent=guiEvent)
+            elif e_type == 'key_release':
+                self.key_release_event(key, guiEvent=guiEvent)
+        handle_key_press = handle_key_release = _handle_key
+
 
 class FigureManager(FigureManagerWebAgg):
     ToolbarCls = Toolbar
diff --git a/js/src/mpl_widget.js b/js/src/mpl_widget.js
index a28374ab..7bf3475c 100644
--- a/js/src/mpl_widget.js
+++ b/js/src/mpl_widget.js
@@ -644,31 +644,27 @@ export class MPLCanvasView extends widgets.DOMWidgetView {
             event.preventDefault();
 
             // Prevent repeat events
-            if (name == 'key_press') {
-                if (event.which === this._key) {
+            if (name === 'key_press') {
+                if (event.key === this._key) {
                     return;
                 } else {
-                    this._key = event.which;
+                    this._key = event.key;
                 }
             }
-            if (name == 'key_release') {
+            if (name === 'key_release') {
                 this._key = null;
             }
 
             var value = '';
-            if (event.ctrlKey && event.which != 17) {
+            if (event.ctrlKey && event.key !== 'Control') {
                 value += 'ctrl+';
-            }
-            if (event.altKey && event.which != 18) {
+            } else if (event.altKey && event.key !== 'Alt') {
                 value += 'alt+';
-            }
-            if (event.shiftKey && event.which != 16) {
+            } else if (event.shiftKey && event.key !== 'Shift') {
                 value += 'shift+';
             }
 
-            value += 'k';
-            value += event.which.toString();
-
+            value += 'k' + event.key;
             this.model.send_message(name, {
                 key: value,
                 guiEvent: utils.get_simple_keys(event),