Interface CompositionEvent

The DOM CompositionEvent represents events that occur due to the user indirectly entering text.

MDN Reference

interface CompositionEvent {
    AT_TARGET: 2;
    BUBBLING_PHASE: 3;
    CAPTURING_PHASE: 1;
    NONE: 0;
    bubbles: boolean;
    cancelBubble: boolean;
    cancelable: boolean;
    composed: boolean;
    currentTarget: null | EventTarget;
    data: string;
    defaultPrevented: boolean;
    detail: number;
    eventPhase: number;
    isTrusted: boolean;
    returnValue: boolean;
    srcElement: null | EventTarget;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    view: null | Window;
    which: number;
    composedPath(): EventTarget[];
    initCompositionEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: null | Window, dataArg?: string): void;
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    initUIEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: null | Window, detailArg?: number): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (view full)

Properties

AT_TARGET BUBBLING_PHASE CAPTURING_PHASE NONE bubbles cancelBubble cancelable composed currentTarget data defaultPrevented detail eventPhase isTrusted returnValue srcElement target timeStamp type view which

Methods

composedPath initCompositionEvent initEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation

Properties

ReadonlyAT_TARGET

AT_TARGET: 2

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

ReadonlyNONE

NONE: 0

Readonlybubbles

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

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

Readonlycancelable

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

Readonlycomposed

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

ReadonlycurrentTarget

currentTarget: null | EventTarget

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

MDN Reference

Readonlydata

data: string

MDN Reference

ReadonlydefaultPrevented

defaultPrevented: boolean

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

MDN Reference

Readonlydetail

detail: number

MDN Reference

ReadonlyeventPhase

eventPhase: number

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

MDN Reference

ReadonlyisTrusted

isTrusted: boolean

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

MDN Reference

returnValue

returnValue: boolean

Deprecated

MDN Reference

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

Readonlytarget

target: null | EventTarget

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

MDN Reference

ReadonlytimeStamp

timeStamp: number

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

MDN Reference

Readonlytype

type: string

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

MDN Reference

Readonlyview

view: null | Window

MDN Reference

Readonlywhich

which: number

Deprecated

MDN Reference

Methods

composedPath

  • composedPath(): EventTarget[]

  • 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[]

initCompositionEvent

  • initCompositionEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, dataArg?): void

  • Parameters

    • typeArg: string
    • OptionalbubblesArg: boolean
    • OptionalcancelableArg: boolean
    • OptionalviewArg: null | Window
    • OptionaldataArg: string

    Returns void

    Deprecated

    MDN Reference

initEvent

  • initEvent(type, bubbles?, cancelable?): void

  • Parameters

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

    Returns void

    Deprecated

    MDN Reference

initUIEvent

  • initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void

  • Parameters

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

    Returns void

    Deprecated

    MDN Reference

preventDefault

  • preventDefault(): void

  • 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

stopImmediatePropagation

  • stopImmediatePropagation(): 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

stopPropagation

  • stopPropagation(): void

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

    MDN Reference

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods