module:KeyboardEvent

Keyboard event class

Constructor

new module:KeyboardEvent(name, target, eventopt)

MouseEvent constructor

Parameters:
NameTypeAttributesDescription
nameString

Name of the event

targetEventEmitter

Component concerned by the event

eventUIEvent<optional>

Original HTML event For the complete list of key values: https://developer.mozilla.org/en/docs/Web/API/KeyboardEvent/key/Key_Values

Extends

Members

(static) events :KeyboardEvents

Set of supported event name for easy access

Type:
  • KeyboardEvents
Example
component.on(KeyboardEvent.events.up, () => console.log("User release a key"));

(static) keys :KeyboardKeys

Set of keys for easy access

Type:
  • KeyboardKeys
Example
if (key === KeyboardEvent.keys.enter) {
    console.log("This is the enter key");
}

Type Definitions

ArrowKeys

Type:
  • Object
Properties
NameTypeDescription
upString

Up arrow

rightString

Right arrow

downString

Down arrow

leftString

Left arrow

KeyboardEvents

Type:
  • Object
Properties
NameTypeDescription
downString

Keyboard key pressed

upString

Keyboard key released

KeyboardKeys

Type:
  • Object
Properties
NameTypeDescription
backspaceString

Remove last character or return previous screen

enterString

Add line-break or validate entry

deleteString

Remove character in front

escapeString

Cancel or leave screen

controlString

Modifying key (control)

shiftString

Modifying key (uppercase)

fnString

Modifying key (function)

ArrowKeys
tabString

Next input or toggle focus

altString

Modifying key (alternative)

altGrString

Modifying key (alternative grapheme)

pageUpString

Move up one page

pageDownString

Move down one page

startString

Go to start

endString

Go to end

insertString

Insert here or toggle insert mode