pencil.js / keyboard-event / KeyboardEvent

Class: KeyboardEvent<T>

Defined in: keyboard-event.ts:38

Keyboard event class

Extends

• BaseEvent<T>

Type Parameters

Type Parameter	Default type
T	unknown

Constructors

Constructor

new KeyboardEvent<T>(
   name, 
   target, 
   event
): KeyboardEvent<T>;

Defined in: keyboard-event.ts:48

KeyboardEvent constructor

Parameters

Parameter	Type	Description
name	string	Name of the event
target	T	Component concerned by the event
event	KeyboardEvent	Original HTML event

Returns

KeyboardEvent<T>

Overrides

BaseEvent.constructor

Properties

Property	Type	Description	Inherited from	Defined in
bubble	boolean	Should the event continue to bubble up to parents	BaseEvent.bubble	base-event.ts:15
event?	Event	Original DOM event (if any)	BaseEvent.event	base-event.ts:12
key	string	Pressed key value (see https://developer.mozilla.org/en/docs/Web/API/KeyboardEvent/key/Key_Values)	-	keyboard-event.ts:40
name	string	Name of the event	BaseEvent.name	base-event.ts:6
target	T	Component concerned by the event	BaseEvent.target	base-event.ts:9

Accessors

events

Get Signature

get static events(): object;

Defined in: keyboard-event.ts:61

Set of supported event name for easy access

Example

component.on(KeyboardEvent.events.up, () => console.log("User release a key"));

Returns

down

readonly down: "keydown" = "keydown";

Keyboard key pressed

up

readonly up: "keyup" = "keyup";

Keyboard key released

---

keys

Get Signature

get static keys(): object;

Defined in: keyboard-event.ts:71

Set of keys for easy access

Example

if (key === KeyboardEvent.keys.enter) {
    console.log("This is the enter key");
}

Returns

object

alt

readonly alt: "Alt" = "Alt";

altGr

readonly altGr: "AltGraph" = "AltGraph";

arrows

readonly arrows: object;

arrows.down

readonly down: "ArrowDown" = "ArrowDown";

arrows.left

readonly left: "ArrowLeft" = "ArrowLeft";

arrows.right

readonly right: "ArrowRight" = "ArrowRight";

arrows.up

readonly up: "ArrowUp" = "ArrowUp";

backspace

readonly backspace: "Backspace" = "Backspace";

control

readonly control: "Control" = "Control";

delete

readonly delete: "Delete" = "Delete";

end

readonly end: "End" = "End";

enter

readonly enter: "Enter" = "Enter";

escape

readonly escape: "Escape" = "Escape";

fn

readonly fn: "Fn" = "Fn";

insert

readonly insert: "Insert" = "Insert";

pageDown

readonly pageDown: "PageDown" = "PageDown";

pageUp

readonly pageUp: "PageUp" = "PageUp";

shift

readonly shift: "Shift" = "Shift";

space

readonly space: " " = " ";

start

readonly start: "Home" = "Home";

tab

readonly tab: "Tab" = "Tab";

Methods

getModifier()

getModifier(): string;

Defined in: keyboard-event.ts:53

Get the event modifier (should be overridden by child classes)

Returns

string

Overrides

BaseEvent.getModifier

---

prevent()

prevent(): this;

Defined in: base-event.ts:50

Prevent the initial event default behavior

Returns

this

Itself

Inherited from

BaseEvent.prevent

---

stop()

stop(): this;

Defined in: base-event.ts:34

Mark this event as stopped (won't bubble further)

Returns

this

Itself

Inherited from

BaseEvent.stop