keymanapp / keymanapp/keyman

refactor(web): deprecated APIs to remove in v20

Open
#16,385 0 comments 0 reactions 0 assignees View on GitHub
refactor web/
Dominant language
Pascal
Stars
534
Forks
143
Avg merge
2d 10h
Merged PRs (30d)
113

Description

* API endpoints deprecated in v19 (#16351, #16354), to be removed in version 20:
- `keyman.helpURL`
- `keyman.util.rgba()`
- `keyman.util.toFloat()`
- `keyman.util.toNumber()`
- `keyman.util.toNzString()`
* Previously deprecated API endpoints to be removed in version 20:
- `keyman.util.createShim()`
- `keyman.util.showShim()`
- `keyman.util.hideShim()`
- `keyboard.KeyboardID`
* Deprecated IMX functions and endpoints that will be removed in v20:
- `keyman.interface.focusLastActiveElement()`
- `keyman.interface.getLastActiveElement()`
- `keyman.interface.hideHelp()`
- `keyman.interface.showHelp()`
- `keyman.interface.showPinnedHelp()`

* Deprecated IMX functions and endpoints that will be retained for compatibility with legacy IMX keyboards:
- `KeymanWeb.FocusLastActiveElement()`
- `KeymanWeb.GetLastActiveElement()`
- `KeymanWeb.HideHelp()`
- `KeymanWeb.ShowHelp()`
- `KeymanWeb.ShowPinnedHelp()`

* Deprecated functions and endpoints that will be retained for compatibility with legacy keyboards:
- `KeymanWeb.KA()`
- `KeymanWeb.KC()`
- `KeymanWeb.KCM()`
- `KeymanWeb.KDM()`

See-also: #16386

Contributor guide

Open the contributing guide

Research direction

Start by locating the definitions and references for each listed deprecated API and endpoint, then separate the APIs slated for removal from the legacy compatibility APIs that must remain. Done means the v20 removal list is no longer exposed while the listed legacy KeymanWeb APIs remain available for compatibility; verify the affected web tests if present.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.