event.keyCode is deprecated - should we use event.key in $tw.keyboardManager?

[BurningTreeC]

https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode

There's a big red box stating that event.keyCode is deprecated in favor of event.key

For the sake of future compatibility and simplicity, shouldn't we use event.key in $tw.keyboardManager?

[pmario]

Can you link to the file(s) at GH where where you think we should change it.

I did a global search for event.keycode -- It is used 15 times in 9 files in several plugins. I am pretty sure, that this element will stay for quite some time. I think it is not urgent.

I found at the tw modules, where we can change them

• TiddlyWiki5/core/modules/keyboard.js

  Line 276 in 5ea4077

  event.keyCode === keyInfo.keyCode &&

• TiddlyWiki5/core/modules/widgets/edit-shortcut.js

  Lines 105 to 112 in 5ea4077

  	if(event.keyCode && $tw.keyboardManager.getModifierKeys().indexOf(event.keyCode) === -1) {
  	// Get the shortcut text representation
  	var value = $tw.keyboardManager.getPrintableShortcuts([{
  	ctrlKey: event.ctrlKey,
  	shiftKey: event.shiftKey,
  	altKey: event.altKey,
  	metaKey: event.metaKey,
  	keyCode: event.keyCode

[BurningTreeC]

Hi @pmario - these are exactly the places where they should be changed.
Then also the long object namedKeys wouldn't be needed anymore - we wouldn't need to convert keyCodes to named keys and vice versa

[BurningTreeC]

I have already a working prototype

[pmario]

If it works already, you should create a PR. IMO it's worth it.

But as I wrote, we do have several 3rd party plugins, that use libraries which also use event.keyCode ... So I think browser vendors will keep the function for quite some time.

[saqimtiaz]

For the sake of future compatibility and simplicity, shouldn't we use event.key in $tw.keyboardManager?

I don't believe we can do so until we officially stop supporting Internet Explorer. As I recall, event.key is not properly supported in IE.

[BurningTreeC]

For the sake of future compatibility and simplicity, shouldn't we use event.key in $tw.keyboardManager?

I don't believe we can do so until we officially stop supporting Internet Explorer. As I recall, event.key is not properly supported in IE.

That's too bad. It seems to be partially supported but broken: https://caniuse.com/?search=event.key

I would need this for the CodeMirror 6 plugin. I would like to add Keyboard Shortcuts through TiddlyWiki's UI.
CodeMirror internally doesn't use shortcuts like ctrl-Comma but uses ctrl-,

[BurningTreeC]

For the sake of future compatibility and simplicity, shouldn't we use event.key in $tw.keyboardManager?

I don't believe we can do so until we officially stop supporting Internet Explorer. As I recall, event.key is not properly supported in IE.

That's too bad. It seems to be partially supported but broken: https://caniuse.com/?search=event.key

I would need this for the CodeMirror 6 plugin. I would like to add Keyboard Shortcuts through TiddlyWiki's UI. CodeMirror internally doesn't use shortcuts like ctrl-Comma but uses ctrl-,

I will then maybe need a conversion table

[pmario]

@saqimtiaz ... IMO this one should be added to Planning for v5.4.0

[saqimtiaz]

@pmario It looks like only PRs and Issues can be added to project plans.

[pmario]

ahhh. OK. Can you convert it into an issue?

[pmario]

@saqimtiaz -- I saw you did create a completely new issue.

I thought there would be a button here in the discussion UI, to convert the discussion into an issue?

[saqimtiaz]

@pmario that is what converting the discussion into an issue does, it creates an entirely new issue linked to the discussion.

[BurningTreeC]

Hi all, I'll create a PR now that addresses this discussion

[saqimtiaz]

Please continue the discussion at #9140