Keyboard Layout Issues in WebMKS SDK 2.2
search cancel

Keyboard Layout Issues in WebMKS SDK 2.2

book

Article ID: 399555

calendar_today

Updated On:

Products

VMware vCenter Server

Issue/Introduction

The default Keyboard Manager in WebMKS SDK 2.2 currently ignores the keyboardLayoutId option when initializing the console. This may result in different keyboard behavior compared to previous SDK versions (2.1 and earlier).

Environment

VMware HTML Console SDK 2.2.0 (or)

WebMKS SDK 2.2.0

Cause

The issue is due to a change in the default Keyboard Manager implementation in WebMKS SDK 2.2.0. The new Keyboard Manager uses KeyboardEvent.code to get VSCANS for key presses. As a result, the keyboardLayoutId option is no longer considered.

Resolution

To address this issue, you can utilize the disableVscanKeyboard option during WebMKS initialization. This option allows you to select the desired keyboard manager implementation.

Using the disableVscanKeyboard option:
To revert to the previous keyboard manager: Set the 'disableVscanKeyboard' option to true when creating the WebMKS instance. This will ensure the old keyboard manager is used, taking the keyboardLayoutId into account.

Example:
`WMKS.createWMKS("wmksContainer", { keyboardLayoutId: 'en-US', disableVscanKeyboard: true });`

To use the new Keyboard Manager 2: Set the disableVscanKeyboard option to false (or omit it). The console will then utilize the new Keyboard Manager.

Note:
By setting disableVscanKeyboard to true, you will be using the older keyboard manager, which may have different functionalities and limitations compared to the new Keyboard Manager.

Additional Information

Future releases will focus on enhancing the new default Keyboard Manager and resolving keyboard-related issues.