vot.js - v2.4.12
    Preparing search index...

    Interface KeyboardEvent

    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

    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: null | 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: null | EventTarget;
        target: null | EventTarget;
        timeStamp: number;
        type: string;
        view: null | Window;
        which: number;
        composedPath(): EventTarget[];
        composedPath(): [EventTarget?];
        getModifierState(keyArg: string): boolean;
        initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
        initKeyboardEvent(
            typeArg: string,
            bubblesArg?: boolean,
            cancelableArg?: boolean,
            viewArg?: null | Window,
            keyArg?: string,
            locationArg?: number,
            ctrlKey?: boolean,
            altKey?: boolean,
            shiftKey?: boolean,
            metaKey?: boolean,
        ): void;
        initUIEvent(
            typeArg: string,
            bubblesArg?: boolean,
            cancelableArg?: boolean,
            viewArg?: null | Window,
            detailArg?: number,
        ): void;
        preventDefault(): void;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        stopPropagation(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    altKey AT_TARGET bubbles BUBBLING_PHASE cancelable cancelBubble CAPTURING_PHASE charCode code composed ctrlKey currentTarget defaultPrevented detail DOM_KEY_LOCATION_LEFT DOM_KEY_LOCATION_NUMPAD DOM_KEY_LOCATION_RIGHT DOM_KEY_LOCATION_STANDARD eventPhase isComposing isTrusted key keyCode location metaKey NONE repeat returnValue shiftKey srcElement target timeStamp type view which

    Methods

    composedPath getModifierState initEvent initKeyboardEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation

    Properties

    altKey: boolean

    MDN Reference

    AT_TARGET: 2
    bubbles: boolean

    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.

    MDN Reference

    BUBBLING_PHASE: 3
    cancelable: boolean

    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.

    MDN Reference

    cancelBubble: boolean

    MDN Reference

    CAPTURING_PHASE: 1
    charCode: number

    MDN Reference

    code: string

    MDN Reference

    composed: boolean

    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.

    MDN Reference

    ctrlKey: boolean

    MDN Reference

    currentTarget: null | EventTarget

    Returns the object whose event listener's callback is currently being invoked.

    MDN Reference

    defaultPrevented: boolean

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

    MDN Reference

    detail: number

    MDN Reference

    DOM_KEY_LOCATION_LEFT: 1
    DOM_KEY_LOCATION_NUMPAD: 3
    DOM_KEY_LOCATION_RIGHT: 2
    DOM_KEY_LOCATION_STANDARD: 0
    eventPhase: number

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    MDN Reference

    isComposing: boolean

    MDN Reference

    isTrusted: boolean

    Returns true if event was dispatched by the user agent, and false otherwise.

    MDN Reference

    key: string

    MDN Reference

    keyCode: number

    MDN Reference

    location: number

    MDN Reference

    metaKey: boolean

    MDN Reference

    NONE: 0
    repeat: boolean

    MDN Reference

    returnValue: boolean

    MDN Reference

    shiftKey: boolean

    MDN Reference

    srcElement: null | EventTarget

    MDN Reference

    target: null | EventTarget

    Returns the object to which event is dispatched (its target).

    MDN Reference

    timeStamp: number

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

    MDN Reference

    type: string

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    MDN Reference

    view: null | Window

    MDN Reference

    which: number

    MDN Reference

    Methods

    • 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.

      MDN Reference

      Returns EventTarget[]

    • Returns an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness.

      Returns [EventTarget?]

    • MDN Reference

      Parameters

      • keyArg: string

      Returns boolean

    • Parameters

      • type: string
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean

      Returns void

      MDN Reference

    • Parameters

      • typeArg: string
      • OptionalbubblesArg: boolean
      • OptionalcancelableArg: boolean
      • OptionalviewArg: null | Window
      • OptionalkeyArg: string
      • OptionallocationArg: number
      • OptionalctrlKey: boolean
      • OptionalaltKey: boolean
      • OptionalshiftKey: boolean
      • OptionalmetaKey: boolean

      Returns void

      MDN Reference

    • Parameters

      • typeArg: string
      • OptionalbubblesArg: boolean
      • OptionalcancelableArg: boolean
      • OptionalviewArg: null | Window
      • OptionaldetailArg: number

      Returns void

      MDN Reference

    • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      MDN Reference

      Returns void

    • Sets the defaultPrevented property to true if cancelable is true.

      Returns void

    • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      MDN Reference

      Returns void

    • Stops the invocation of event listeners after the current one completes.

      Returns void

    • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      MDN Reference

      Returns void

    • This is not used in Node.js and is provided purely for completeness.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods