CustomEvent
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Implements
Constructors
new CustomEvent()
new CustomEvent<T>(type, options): CustomEvent<T>
Parameters
| Parameter | Type |
|---|---|
type | string |
options | CustomEventInit<T> |
Returns
CustomEvent<T>
Overrides
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
AT_TARGET | readonly | 2 | - | globalThis.CustomEvent.AT_TARGET Event.AT_TARGET |
bubbles | readonly | 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 | globalThis.CustomEvent.bubbles Event.bubbles |
BUBBLING_PHASE | readonly | 3 | - | globalThis.CustomEvent.BUBBLING_PHASE Event.BUBBLING_PHASE |
cancelable | readonly | 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 | globalThis.CustomEvent.cancelable Event.cancelable |
cancelBubble | public | boolean | Deprecated MDN Reference | globalThis.CustomEvent.cancelBubble Event.cancelBubble |
CAPTURING_PHASE | readonly | 1 | - | globalThis.CustomEvent.CAPTURING_PHASE Event.CAPTURING_PHASE |
composed | readonly | 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 | globalThis.CustomEvent.composed Event.composed |
currentTarget | readonly | null | EventTarget | Returns the object whose event listener's callback is currently being invoked. MDN Reference | globalThis.CustomEvent.currentTarget Event.currentTarget |
defaultPrevented | readonly | boolean | Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. MDN Reference | globalThis.CustomEvent.defaultPrevented Event.defaultPrevented |
detail | readonly | null | T | Returns any custom data event was created with. Typically used for synthetic events. MDN Reference | - |
eventPhase | readonly | number | Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. MDN Reference | globalThis.CustomEvent.eventPhase Event.eventPhase |
isTrusted | readonly | boolean | Returns true if event was dispatched by the user agent, and false otherwise. MDN Reference | globalThis.CustomEvent.isTrusted Event.isTrusted |
NONE | readonly | 0 | - | globalThis.CustomEvent.NONE Event.NONE |
returnValue | public | boolean | Deprecated MDN Reference | globalThis.CustomEvent.returnValue Event.returnValue |
srcElement | readonly | null | EventTarget | Deprecated MDN Reference | globalThis.CustomEvent.srcElement Event.srcElement |
target | readonly | null | EventTarget | Returns the object to which event is dispatched (its target). MDN Reference | globalThis.CustomEvent.target Event.target |
timeStamp | readonly | number | Returns the event's timestamp as the number of milliseconds measured relative to the time origin. MDN Reference | globalThis.CustomEvent.timeStamp Event.timeStamp |
type | readonly | string | Returns the type of event, e.g. "click", "hashchange", or "submit". MDN Reference | globalThis.CustomEvent.type Event.type |
AT_TARGET | readonly | 2 | - | Event.AT_TARGET |
BUBBLING_PHASE | readonly | 3 | - | Event.BUBBLING_PHASE |
CAPTURING_PHASE | readonly | 1 | - | Event.CAPTURING_PHASE |
NONE | readonly | 0 | - | Event.NONE |
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.
Returns
Implementation of
globalThis.CustomEvent.composedPath
Inherited from
initCustomEvent()
initCustomEvent(): void
Returns
void
Implementation of
globalThis.CustomEvent.initCustomEvent
Deprecated
initEvent()
initEvent(type, bubbles?, cancelable?): void
Parameters
| Parameter | Type |
|---|---|
type | string |
bubbles? | boolean |
cancelable? | boolean |
Returns
void
Implementation of
globalThis.CustomEvent.initEvent
Inherited from
Deprecated
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.
Returns
void
Implementation of
globalThis.CustomEvent.preventDefault
Inherited from
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.
Returns
void
Implementation of
globalThis.CustomEvent.stopImmediatePropagation
Inherited from
Event.stopImmediatePropagation
stopPropagation()
stopPropagation(): void
When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
Returns
void
Implementation of
globalThis.CustomEvent.stopPropagation