trait SyntheticKeyboardEvent[+DOMEventTarget <: Node] extends Object with SyntheticUIEvent[DOMEventTarget]
https://github.com/facebook/react/blob/master/packages/react-dom/src/events/SyntheticKeyboardEvent.js
- Annotations
- @JSType() @native() @nowarn()
- Alphabetic
- By Inheritance
- SyntheticKeyboardEvent
- SyntheticUIEvent
- SyntheticEvent
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val altKey: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val bubbles: Boolean
- Definition Classes
- SyntheticEvent
- val cancelable: Boolean
- Definition Classes
- SyntheticEvent
- val charCode: Int
printable keys (letters, numbers, symbols)
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val code: String
The KeyboardEvent.code property represents a physical key on the keyboard (as opposed to the character generated by pressing the key).
The KeyboardEvent.code property represents a physical key on the keyboard (as opposed to the character generated by pressing the key). In other words, this property returns a value that isn't altered by keyboard layout or the state of the modifier keys.
If the input device isn't a physical keyboard, but is instead a virtual keyboard or accessibility device, the returned value will be set by the browser to match as closely as possible to what would happen with a physical keyboard, to maximize compatibility between physical and virtual input devices.
This property is useful when you want to handle keys based on their physical positions on the input device rather than the characters associated with those keys; this is especially common when writing code to handle input for games that simulate a gamepad-like environment using keys on the keyboard. Be aware, however, that you can't use the value reported by KeyboardEvent.code to determine the character generated by the keystroke, because the keycode's name may not match the actual character that's printed on the key or that's generated by the computer when the key is pressed.
For example, the code returned is "KeyQ" for the Q key on a QWERTY layout keyboard, but the same code value also represents the ' key on Dvorak keyboards and the A key on AZERTY keyboards. That makes it impossible to use the value of code to determine what the name of the key is to users if they're not using an anticipated keyboard layout.
To determine what character corresponds with the key event, use the KeyboardEvent.key property instead.
- val ctrlKey: Boolean
- val currentTarget: DOMEventTarget
- Definition Classes
- SyntheticEvent
- def defaultPrevented: Boolean
- Definition Classes
- SyntheticEvent
- def detail: Double
Specifies some detail information about the Event, depending on the type of event.
Specifies some detail information about the Event, depending on the type of event. The un-initialized value of this attribute must be 0.
- Definition Classes
- SyntheticUIEvent
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val eventPhase: Double
- Definition Classes
- SyntheticEvent
- val eventType: String
- Definition Classes
- SyntheticEvent
- Annotations
- @JSName("type")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getModifierState(keyArg: String): Boolean
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def isDefaultPrevented(): Boolean
- Definition Classes
- SyntheticEvent
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPersistent(): Boolean
- Definition Classes
- SyntheticEvent
- def isPropagationStopped(): Boolean
- Definition Classes
- SyntheticEvent
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- val isTrusted: Boolean
- Definition Classes
- SyntheticEvent
- val key: String
The KeyboardEvent interface's key read-only property returns the value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout.
The KeyboardEvent interface's key read-only property returns the value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout. Its value is determined as follows:
- If the pressed key has a printed representation, the returned value is a non-empty Unicode character string containing the printable representation of the key.
- If the pressed key is a control or special character, the returned value is one of the pre-defined key values.
- If the KeyboardEvent represents the press of a dead key, the key value must be "Dead".
- Some specialty keyboard keys (such as the extended keys for controlling media on multimedia keyboards) don't generate key codes on Windows; instead, they trigger WM_APPCOMMAND events. These events get mapped to DOM keyboard events, and are listed among the "Virtual key codes" for Windows, even though they aren't actually key codes.
- If the key cannot be identified, the returned value is Unidentified.
- val keyCode: Int
non-printable keys (modifiers, arrow keys, tab, esc)
- val locale: String
- val location: Double
- val metaKey: Boolean
- val nativeEvent: KeyboardEvent
- Definition Classes
- SyntheticKeyboardEvent → SyntheticUIEvent → SyntheticEvent
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def persist(): Unit
If you want to access the event properties in an asynchronous way, call this on the event, which will remove the synthetic event from the pool and allow references to the event to be retained by user code.
If you want to access the event properties in an asynchronous way, call this on the event, which will remove the synthetic event from the pool and allow references to the event to be retained by user code.
- Definition Classes
- SyntheticEvent
- def preventDefault(): Unit
Stops the default action of an element from happening.
Stops the default action of an element from happening. For example: Prevent a submit button from submitting a form Prevent a link from following the URL
- Definition Classes
- SyntheticEvent
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- val repeat: Boolean
- val shiftKey: Boolean
- def stopPropagation(): Unit
Stops the bubbling of an event to parent elements, preventing any parent event handlers from being executed.
Stops the bubbling of an event to parent elements, preventing any parent event handlers from being executed.
- Definition Classes
- SyntheticEvent
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val target: DOMEventTarget
- Definition Classes
- SyntheticEvent
- val timeStamp: Double
- Definition Classes
- SyntheticEvent
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def valueOf(): Any
- Definition Classes
- Object
- val view: Object
The view attribute identifies the AbstractView from which the event was generated.
The view attribute identifies the AbstractView from which the event was generated. The un-initialized value of this attribute must be null.
- Definition Classes
- SyntheticUIEvent
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val which: Int
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated