RelevantKeyboardEvent
Defined in: src/hooks/useLastComponentBeforeTabpanel.ts:47
Extends
Section titled “Extends”KeyboardEvent
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|
altKey |
public |
boolean |
- | - | KeyboardEvent.altKey |
node_modules/@types/react/index.d.ts:2122 |
bubbles |
public |
boolean |
- | - | KeyboardEvent.bubbles |
node_modules/@types/react/index.d.ts:2024 |
cancelable |
public |
boolean |
- | - | KeyboardEvent.cancelable |
node_modules/@types/react/index.d.ts:2025 |
charCode |
public |
number |
:::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: | - | KeyboardEvent.charCode |
node_modules/@types/react/index.d.ts:2124 |
code |
public |
string |
- | - | KeyboardEvent.code |
node_modules/@types/react/index.d.ts:2126 |
ctrlKey |
public |
boolean |
- | - | KeyboardEvent.ctrlKey |
node_modules/@types/react/index.d.ts:2125 |
currentTarget |
public |
EventTarget & Element |
- | - | KeyboardEvent.currentTarget |
node_modules/@types/react/index.d.ts:2022 |
defaultPrevented |
public |
boolean |
- | - | KeyboardEvent.defaultPrevented |
node_modules/@types/react/index.d.ts:2026 |
detail |
public |
number |
- | - | KeyboardEvent.detail |
node_modules/@types/react/index.d.ts:2190 |
eventPhase |
public |
number |
- | - | KeyboardEvent.eventPhase |
node_modules/@types/react/index.d.ts:2027 |
isTrusted |
public |
boolean |
- | - | KeyboardEvent.isTrusted |
node_modules/@types/react/index.d.ts:2028 |
key |
public |
"Tab" |
See the DOM Level 3 Events spec. for possible values | KeyboardEvent.key |
- | src/hooks/useLastComponentBeforeTabpanel.ts:48 |
keyCode |
public |
number |
:::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: | - | KeyboardEvent.keyCode |
node_modules/@types/react/index.d.ts:2136 |
locale |
public |
string |
- | - | KeyboardEvent.locale |
node_modules/@types/react/index.d.ts:2137 |
location |
public |
number |
- | - | KeyboardEvent.location |
node_modules/@types/react/index.d.ts:2138 |
metaKey |
public |
boolean |
- | - | KeyboardEvent.metaKey |
node_modules/@types/react/index.d.ts:2139 |
nativeEvent |
public |
object |
- | KeyboardEvent.nativeEvent |
- | src/hooks/useLastComponentBeforeTabpanel.ts:49 |
nativeEvent.altKey |
readonly |
boolean |
The KeyboardEvent.altKey read-only property is a boolean value that indicates if the alt key (Option or ⌥ on macOS) was pressed (true) or not (false) when the event occurred. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23160 |
nativeEvent.AT_TARGET |
readonly |
2 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14273 |
nativeEvent.bubbles |
readonly |
boolean |
The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14164 |
nativeEvent.BUBBLING_PHASE |
readonly |
3 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14274 |
nativeEvent.cancelable |
readonly |
boolean |
The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14177 |
nativeEvent.cancelBubble |
public |
boolean |
The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details. :::caution[Deprecated] MDN Reference ::: |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14171 |
nativeEvent.CAPTURING_PHASE |
readonly |
1 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14272 |
nativeEvent.charCode |
readonly |
number |
The charCode read-only property of the KeyboardEvent interface returns the Unicode value of a character key pressed during a keypress event. :::caution[Deprecated] MDN Reference ::: |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23167 |
nativeEvent.code |
readonly |
string |
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. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23173 |
nativeEvent.composed |
readonly |
boolean |
The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14183 |
nativeEvent.ctrlKey |
readonly |
boolean |
The KeyboardEvent.ctrlKey read-only property returns a boolean value that indicates if the control key was pressed (true) or not (false) when the event occurred. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23179 |
nativeEvent.currentTarget |
readonly |
EventTarget | null |
The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14189 |
nativeEvent.defaultPrevented |
readonly |
boolean |
The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14195 |
nativeEvent.detail |
readonly |
number |
The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:37281 |
nativeEvent.DOM_KEY_LOCATION_LEFT |
readonly |
1 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23237 |
nativeEvent.DOM_KEY_LOCATION_NUMPAD |
readonly |
3 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23239 |
nativeEvent.DOM_KEY_LOCATION_RIGHT |
readonly |
2 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23238 |
nativeEvent.DOM_KEY_LOCATION_STANDARD |
readonly |
0 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23236 |
nativeEvent.eventPhase |
readonly |
number |
The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14201 |
nativeEvent.isComposing |
readonly |
boolean |
The KeyboardEvent.isComposing read-only property returns a boolean value indicating if the event is fired within a composition session, i.e., after compositionstart and before compositionend. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23185 |
nativeEvent.isTrusted |
readonly |
boolean |
The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14207 |
nativeEvent.key |
readonly |
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. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23191 |
nativeEvent.keyCode |
readonly |
number |
The deprecated KeyboardEvent.keyCode read-only property represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key. :::caution[Deprecated] MDN Reference ::: |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23198 |
nativeEvent.location |
readonly |
number |
The KeyboardEvent.location read-only property returns an unsigned long representing the location of the key on the keyboard or other input device. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23204 |
nativeEvent.metaKey |
readonly |
boolean |
The KeyboardEvent.metaKey read-only property returning a boolean value that indicates if the Meta key was pressed (true) or not (false) when the event occurred. Some operating systems may intercept the key so it is never detected. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23210 |
nativeEvent.NONE |
readonly |
0 |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14271 |
nativeEvent.repeat |
readonly |
boolean |
The repeat read-only property of the KeyboardEvent interface returns a boolean value that is true if the given key is being held down such that it is automatically repeating. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23216 |
nativeEvent.returnValue |
public |
boolean |
The Event property returnValue indicates whether the default action for this event has been prevented or not. :::caution[Deprecated] MDN Reference ::: |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14214 |
nativeEvent.shiftKey |
readonly |
boolean |
The KeyboardEvent.shiftKey read-only property is a boolean value that indicates if the shift key was pressed (true) or not (false) when the event occurred. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23222 |
nativeEvent.srcElement |
readonly |
EventTarget | null |
The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead. :::caution[Deprecated] MDN Reference ::: |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14221 |
nativeEvent.target |
readonly |
EventTarget | null |
The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14227 |
nativeEvent.timeStamp |
readonly |
number |
The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14233 |
nativeEvent.type |
public |
"keydown" |
- | - | - | src/hooks/useLastComponentBeforeTabpanel.ts:51 |
nativeEvent.view |
readonly |
Window | null |
The UIEvent.view read-only property returns the WindowProxy object from which the event was generated. In browsers, this is the Window object the event happened in. MDN Reference |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:37287 |
nativeEvent.which |
readonly |
number |
The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard. :::caution[Deprecated] MDN Reference ::: |
- | - | docs/node_modules/typescript/lib/lib.dom.d.ts:37294 |
nativeEvent.composedPath |
public |
EventTarget[] |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14245 |
nativeEvent.getModifierState |
public |
boolean |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23228 |
nativeEvent.initEvent |
public |
void |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14252 |
nativeEvent.initKeyboardEvent |
public |
void |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:23235 |
nativeEvent.initUIEvent |
public |
void |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:37301 |
nativeEvent.preventDefault |
public |
void |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14258 |
nativeEvent.stopImmediatePropagation |
public |
void |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14264 |
nativeEvent.stopPropagation |
public |
void |
- | - | - | docs/node_modules/typescript/lib/lib.dom.d.ts:14270 |
repeat |
public |
boolean |
- | - | KeyboardEvent.repeat |
node_modules/@types/react/index.d.ts:2140 |
shiftKey |
public |
true |
- | KeyboardEvent.shiftKey |
- | src/hooks/useLastComponentBeforeTabpanel.ts:53 |
target |
public |
EventTarget |
- | - | KeyboardEvent.target |
node_modules/@types/react/index.d.ts:2023 |
timeStamp |
public |
number |
- | - | KeyboardEvent.timeStamp |
node_modules/@types/react/index.d.ts:2034 |
type |
public |
string |
- | - | KeyboardEvent.type |
node_modules/@types/react/index.d.ts:2035 |
view |
public |
AbstractView |
- | - | KeyboardEvent.view |
node_modules/@types/react/index.d.ts:2191 |
which |
public |
number |
:::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: | - | KeyboardEvent.which |
node_modules/@types/react/index.d.ts:2143 |
Methods
Section titled “Methods”getModifierState()
Section titled “getModifierState()”getModifierState(
key):boolean
Defined in: node_modules/@types/react/index.d.ts:2130
See DOM Level 3 Events spec. for a list of valid (case-sensitive) arguments to this method.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
ModifierKey |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”KeyboardEvent.getModifierState
isDefaultPrevented()
Section titled “isDefaultPrevented()”isDefaultPrevented():
boolean
Defined in: node_modules/@types/react/index.d.ts:2030
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”KeyboardEvent.isDefaultPrevented
isPropagationStopped()
Section titled “isPropagationStopped()”isPropagationStopped():
boolean
Defined in: node_modules/@types/react/index.d.ts:2032
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”KeyboardEvent.isPropagationStopped
persist()
Section titled “persist()”persist():
void
Defined in: node_modules/@types/react/index.d.ts:2033
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”KeyboardEvent.persist
preventDefault()
Section titled “preventDefault()”preventDefault():
void
Defined in: node_modules/@types/react/index.d.ts:2029
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”KeyboardEvent.preventDefault
stopPropagation()
Section titled “stopPropagation()”stopPropagation():
void
Defined in: node_modules/@types/react/index.d.ts:2031
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”KeyboardEvent.stopPropagation