KeyboardEvent class

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

Implemented types
Available extensions
Annotations
  • @JS()
  • @staticInterop

Constructors

KeyboardEvent.new(String type, [KeyboardEventInit? eventInitDict])
factory

Properties

altKey bool

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
atTarget num

Available on Event, provided by the Event$Typings extension

no setter
bubbles bool

Available on Event, provided by the Event$Typings extension

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.
no setter
bubblingPhase num

Available on Event, provided by the Event$Typings extension

no setter
cancelable bool

Available on Event, provided by the Event$Typings extension

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.
no setter
cancelBubble bool

Available on Event, provided by the Event$Typings extension

@deprecated
getter/setter pair
capturingPhase num

Available on Event, provided by the Event$Typings extension

no setter
charCode num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

no setter
code String

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
composed bool

Available on Event, provided by the Event$Typings extension

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.
no setter
composedPath List<EventTarget> Function()

Available on Event, provided by the Event$Typings extension

getter/setter pair
ctrlKey bool

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
currentTarget EventTarget?

Available on Event, provided by the Event$Typings extension

Returns the object whose event listener's callback is currently being invoked.
no setter
defaultPrevented bool

Available on Event, provided by the Event$Typings extension

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
no setter
detail num

Available on UIEvent, provided by the UIEvent$Typings extension

MDN Reference
no setter
domKeyLocationLeft num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

no setter
domKeyLocationNumpad num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

no setter
domKeyLocationRight num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

no setter
domKeyLocationStandard num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

no setter
eventPhase num

Available on Event, provided by the Event$Typings extension

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
no setter
getModifierState bool Function(String)

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
initEvent ↔ void Function(String, [bool?, bool?])

Available on Event, provided by the Event$Typings extension

getter/setter pair
initKeyboardEvent ↔ void Function(String, [bool?, bool?, Window?, String?, num?, bool?, bool?, bool?, bool?])

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

getter/setter pair
initUIEvent ↔ void Function(String, [bool?, bool?, Window?, num?])

Available on UIEvent, provided by the UIEvent$Typings extension

getter/setter pair
isComposing bool

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
isTrusted bool

Available on Event, provided by the Event$Typings extension

Returns true if event was dispatched by the user agent, and false otherwise.
no setter
key String

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
keyCode num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

no setter
location num

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
metaKey bool

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
none num

Available on Event, provided by the Event$Typings extension

no setter
preventDefault ↔ void Function()

Available on Event, provided by the Event$Typings extension

getter/setter pair
repeat bool

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
returnValue bool

Available on Event, provided by the Event$Typings extension

@deprecated
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shiftKey bool

Available on KeyboardEvent, provided by the KeyboardEvent$Typings extension

MDN Reference
no setter
srcElement EventTarget?

Available on Event, provided by the Event$Typings extension

no setter
stopImmediatePropagation ↔ void Function()

Available on Event, provided by the Event$Typings extension

getter/setter pair
stopPropagation ↔ void Function()

Available on Event, provided by the Event$Typings extension

getter/setter pair
target EventTarget?

Available on Event, provided by the Event$Typings extension

Returns the object to which event is dispatched (its target).
no setter
timeStamp num

Available on Event, provided by the Event$Typings extension

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
no setter
type String

Available on Event, provided by the Event$Typings extension

Returns the type of event, e.g. "click", "hashchange", or "submit".
no setter
view Window?

Available on UIEvent, provided by the UIEvent$Typings extension

MDN Reference
no setter
which num

Available on UIEvent, provided by the UIEvent$Typings extension

no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

domKeyLocationLeft num
no setter
domKeyLocationNumpad num
no setter
domKeyLocationRight num
no setter
domKeyLocationStandard num
no setter