A custom KeyboardEvent that attempts to eliminate cross-browser inconsistencies, and also provide both keyCode and charCode information for all key events (when such information can be determined).

KeyEvent tries to provide a higher level, more polished keyboard event information on top of the "raw" KeyboardEvent.

The mechanics of using KeyEvents is a little different from the underlying KeyboardEvent. To use KeyEvents, you need to create a stream and then add KeyEvents to the stream, rather than using the EventTarget.dispatchEvent. Here's an example usage:

// Initialize a stream for the KeyEvents:
var stream = KeyEvent.keyPressEvent.forTarget(document.body);
// Start listening to the stream of KeyEvents.
stream.listen((keyEvent) =>
    window.console.log('KeyPress event detected ${keyEvent.charCode}'));
...
// Add a new KeyEvent of someone pressing the 'A' key to the stream so
// listeners can know a KeyEvent happened.
stream.add(new KeyEvent('keypress', keyCode: 65, charCode: 97));

This class is very much a work in progress, and we'd love to get information on how we can make this class work with as many international keyboards as possible. Bugs welcome!

Implements
Annotations
  • Experimental()

Static Properties

keyDownEvent → EventStreamProvider<KeyEvent>
read / write

Accessor to provide a stream of KeyEvents on the desired target.

keyPressEvent → EventStreamProvider<KeyEvent>
read / write

Accessor to provide a stream of KeyEvents on the desired target.

keyUpEvent → EventStreamProvider<KeyEvent>
read / write

Accessor to provide a stream of KeyEvents on the desired target.

Properties

altKey → bool
read-only

Caculated value of whether the alt key is pressed is for this event.

bubbles → bool
read-only, inherited

cancelable → bool
read-only, inherited

charCode → int
read-only

Caculated value of what the estimated charCode is for this event.

clipboardData → DataTransfer
read-only

Accessor to the clipboardData available for this event.

ctrlKey → bool
read-only

True if the ctrl key is pressed during this event.

currentTarget → EventTarget
read-only

The currently registered target for this event.

defaultPrevented → bool
read-only, inherited

detail → int
read-only

eventPhase → int
read-only, inherited

keyCode → int
read-only

Caculated value of what the estimated keyCode is for this event.

keyLocation → int
read-only

Accessor to the part of the keyboard that the key was pressed from (one of KeyLocation.STANDARD, KeyLocation.RIGHT, KeyLocation.LEFT, KeyLocation.NUMPAD, KeyLocation.MOBILE, KeyLocation.JOYSTICK).

layer → Point
read-only

location → int
read-only

matchingTarget → Element
read-only, inherited

A pointer to the element whose CSS selector matched within which an event was fired. If this Event was not associated with any Event delegation, accessing this value will throw an UnsupportedError.

metaKey → bool
read-only

True if the Meta (or Mac command) key is pressed during this event.

page → Point
read-only

path → List<Node>
read-only, inherited

This event's path, taking into account shadow DOM.…

repeat → bool
read-only

shiftKey → bool
read-only

True if the shift key was pressed during this event.

target → EventTarget
read-only, inherited

timeStamp → int
read-only, inherited

type → String
read-only, inherited

view → Window
read-only

which → int
read-only

Caculated value of what the estimated keyCode is for this event.

wrapped → Event
read-only, inherited

Constructors

KeyEvent(String type, {Window view, bool canBubble: true, bool cancelable: true, int keyCode: 0, int charCode: 0, int keyLocation: 1, bool ctrlKey: false, bool altKey: false, bool shiftKey: false, bool metaKey: false, EventTarget currentTarget})

Programmatically create a new KeyEvent (and KeyboardEvent).

KeyEvent.wrap(KeyboardEvent parent)

Construct a KeyEvent with parent as the event we're emulating.

Methods

getModifierState(String keyArgument) → bool

preventDefault() → void
inherited

stopImmediatePropagation() → void
inherited

stopPropagation() → void
inherited