@shopify/oxygen-workers-types
    Preparing search index...

    Class CustomEvent<T>

    An event which takes place in the DOM.

    MDN Reference

    Type Parameters

    • T = any

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    AT_TARGET: number
    BUBBLING_PHASE: number
    CAPTURING_PHASE: number
    NONE: number

    Accessors

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

      Returns boolean

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

      Returns boolean

    • get cancelBubble(): boolean

      Returns boolean

      MDN Reference

    • set cancelBubble(value: boolean): void

      Parameters

      • value: boolean

      Returns void

      MDN Reference

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

      Returns boolean

    • get currentTarget(): undefined | EventTarget<Record<string, Event>>

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

      MDN Reference

      Returns undefined | EventTarget<Record<string, Event>>

    • get defaultPrevented(): boolean

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

      MDN Reference

      Returns boolean

    • get detail(): T

      Returns any custom data event was created with. Typically used for synthetic events.

      MDN Reference

      Returns T

    • get eventPhase(): number

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

      MDN Reference

      Returns number

    • get isTrusted(): boolean

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

      MDN Reference

      Returns boolean

    • get returnValue(): boolean

      Returns boolean

      MDN Reference

    • get timeStamp(): number

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

      MDN Reference

      Returns number

    • get type(): string

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

      MDN Reference

      Returns string

    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<Record<string, Event>>[]

    • 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

    • 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

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

      MDN Reference

      Returns void