Interface KeyboardEvent
altKey: boolean;
AT_TARGET: 2;
bubbles: boolean;
BUBBLING_PHASE: 3;
cancelable: boolean;
cancelBubble: boolean;
CAPTURING_PHASE: 1;
charCode: number;
code: string;
composed: boolean;
ctrlKey: boolean;
currentTarget: EventTarget;
defaultPrevented: boolean;
detail: number;
DOM_KEY_LOCATION_LEFT: 1;
DOM_KEY_LOCATION_NUMPAD: 3;
DOM_KEY_LOCATION_RIGHT: 2;
DOM_KEY_LOCATION_STANDARD: 0;
eventPhase: number;
isComposing: boolean;
isTrusted: boolean;
key: string;
keyCode: number;
location: number;
metaKey: boolean;
NONE: 0;
repeat: boolean;
returnValue: boolean;
shiftKey: boolean;
srcElement: EventTarget;
target: EventTarget;
timeStamp: number;
type: string;
view: Window;
which: number;
composedPath(): EventTarget[];
getModifierState(keyArg: string): boolean;
initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
initKeyboardEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: Window, keyArg?: string, locationArg?: number, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): void;
initUIEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: Window, detailArg?: number): void;
preventDefault(): void;
stopImmediatePropagation(): void;
stopPropagation(): void;
}
Index
Properties
Methods
Properties
ReadonlyaltKey
ReadonlyAT_TARGET
Readonlybubbles
Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.
ReadonlyBUBBLING_PHASE
Readonlycancelable
Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.
cancelBubble
ReadonlyCAPTURING_PHASE
ReadonlycharCode
Readonlycode
Readonlycomposed
Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.
ReadonlyctrlKey
ReadonlycurrentTarget
Returns the object whose event listener's callback is currently being invoked.
ReadonlydefaultPrevented
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
Readonlydetail
ReadonlyDOM_KEY_LOCATION_LEFT
ReadonlyDOM_KEY_LOCATION_NUMPAD
ReadonlyDOM_KEY_LOCATION_RIGHT
ReadonlyDOM_KEY_LOCATION_STANDARD
ReadonlyeventPhase
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
ReadonlyisComposing
ReadonlyisTrusted
Returns true if event was dispatched by the user agent, and false otherwise.
Readonlykey
ReadonlykeyCode
Readonlylocation
ReadonlymetaKey
ReadonlyNONE
Readonlyrepeat
returnValue
ReadonlyshiftKey
ReadonlysrcElement
Readonlytarget
Returns the object to which event is dispatched (its target).
ReadonlytimeStamp
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
Readonlytype
Returns the type of event, e.g. "click", "hashchange", or "submit".
Readonlyview
Readonlywhich
Methods
composedPath
- composed
Path (): EventTarget[] Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.
Returns EventTarget[]
getModifierState
initEvent
initKeyboardEvent
- init
Keyboard (typeArg, bubblesArg?, cancelableArg?, viewArg?, keyArg?, locationArg?, ctrlKey?, altKey?, shiftKey?, metaKey?): voidEvent Parameters
- typeArg: string
OptionalbubblesArg: booleanOptionalcancelableArg: booleanOptionalviewArg: WindowOptionalkeyArg: stringOptionallocationArg: numberOptionalctrlKey: booleanOptionalaltKey: booleanOptionalshiftKey: booleanOptionalmetaKey: boolean
Returns void
initUIEvent
- initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void
Parameters
- typeArg: string
OptionalbubblesArg: booleanOptionalcancelableArg: booleanOptionalviewArg: WindowOptionaldetailArg: number
Returns void
KeyboardEvent objects describe a user interaction with the keyboard; each event describes a single interaction between the user and a key (or combination of a key with modifier keys) on the keyboard.
MDN Reference