spiegel-keyman/web/docs/engine/reference/core
Marc Durdin f1361a94f0 feat(web): add keyman.versionInfo API
KeymanWeb has long had `keyman.build` and `keyman.version`. Neither of
these properties expose the full version string, and consumers are
forced to manipulate them to get a partial version string.

This change deprecates both these properties, and introduces a new
`keyman.versionInfo` property, which returns an object with all the
version information, most importantly `full`.

Update documentation and add a unit test for this, following the unit
test pattern established throughout Keyman of a unit test filename
matching the implementation class. The `KeymanEngineBase` class is a
little difficult to instantiate so this unit test module currently has
a minimal instantiation which provides enough to fulfill the one
included test.

Test-bot: skip
2026-08-12 11:07:31 +02:00
..
activatingUI.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
addEventListener.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
addHotKey.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
addKeyboards.md chore(web): address code review comments 2026-06-09 17:13:47 +02:00
addKeyboardsForLanguage.md chore(web): address code review comments 2026-06-08 19:27:12 +02:00
attachToControl.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
build.md feat(web): add keyman.versionInfo API 2026-08-12 11:07:31 +02:00
BuildVisualKeyboard.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
detachFromControl.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
disableControl.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
enableControl.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
focusLastActiveElement.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
getActiveKeyboard.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
getActiveLanguage.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
getKeyboard.md chore(web): address code review comments 2026-06-08 19:27:12 +02:00
getKeyboardForControl.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
getKeyboards.md chore(web): address code review comments 2026-06-08 19:27:12 +02:00
getLastActiveElement.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
getSavedKeyboard.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
getUIState.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
helpURL.md chore(web): update helpURL documentation and float ui link 2025-10-15 07:57:08 +02:00
index.md feat(web): add keyman.versionInfo API 2026-08-12 11:07:31 +02:00
init.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
initialized.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
isChiral.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
isCJK.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
moveToElement.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
removeEventListener.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
removeHotKey.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
removeKeyboards.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
resetContext.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
setActiveKeyboard.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
setKeyboardForControl.md refactor(web): move web engine help to app repo 2024-10-31 11:00:06 +07:00
version.md feat(web): add keyman.versionInfo API 2026-08-12 11:07:31 +02:00
versionInfo.md feat(web): add keyman.versionInfo API 2026-08-12 11:07:31 +02:00