Skip to main content

Interface: KeyConfiguration

Additional, optional properties for a key in the VirtualKeyboard.

Remarks​

This is used to define special keys (e.g., Shift, Backspace), keys with icons, and keys of custom size.

Properties​

blank?​

optional blank: boolean

True is the key should be hidden.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:44

code​

code: string

Identifier for the key.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:38

heightRatio?​

optional heightRatio: number

Width of the key in units of a regular key height. Default is 1.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:36

isShift?​

optional isShift: boolean

True is the key is a shift key.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:46

keyIconShapeOptions?​

optional keyIconShapeOptions: ShapeOptions

ShapeOptions of the optional icon to show on the key.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:48

labelText?​

optional labelText: string

Label to be shown on the key.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:40

labelTextShifted?​

optional labelTextShifted: string

Label to be shown on the key when shift is activated.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:42

widthRatio?​

optional widthRatio: number

Width of the key in units of a regular key width. Default is 1.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:34