Skip to content

Keymap.isModifier method

Keymap › isModifier

Official

Checks whether the modifier key is pressed during this event.

Signature:

isModifier(evt: MouseEvent | KeyboardEvent | TouchEvent, modifier: Modifier): boolean

Parameters:

ParameterTypeDescription
evtMouseEvent | KeyboardEvent | TouchEventThe event.
modifierModifierThe modifier.

Returns: boolean

Since: 0.12.17

Example:

if (Keymap.isModifier(evt, 'Ctrl')) {
console.log('Ctrl is pressed');
}