Interface: CustomEventType<T>
Extends
Event
Type Parameters
• T = unknown
Properties
AT_TARGET
readonlyAT_TARGET:2
Inherited from
Event.AT_TARGET
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8192
bubbles
readonlybubbles: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.
Inherited from
Event.bubbles
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8087
BUBBLING_PHASE
readonlyBUBBLING_PHASE:3
Inherited from
Event.BUBBLING_PHASE
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8193
cancelable
readonlycancelable: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.
Inherited from
Event.cancelable
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8099
cancelBubble
cancelBubble:
boolean
Deprecated
Inherited from
Event.cancelBubble
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8093
CAPTURING_PHASE
readonlyCAPTURING_PHASE:1
Inherited from
Event.CAPTURING_PHASE
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8191
composed
readonlycomposed: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.
Inherited from
Event.composed
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8105
currentTarget
readonlycurrentTarget:EventTarget
Returns the object whose event listener's callback is currently being invoked.
Inherited from
Event.currentTarget
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8111
defaultPrevented
readonlydefaultPrevented:boolean
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
Inherited from
Event.defaultPrevented
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8117
detail
readonlydetail:T
Returns any custom data event was created with. Typically used for synthetic events.
Defined in
packages/core/src/types/CustomEventType.ts:5
eventPhase
readonlyeventPhase:number
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
Inherited from
Event.eventPhase
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8123
isTrusted
readonlyisTrusted:boolean
Returns true if event was dispatched by the user agent, and false otherwise.
Inherited from
Event.isTrusted
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8129
NONE
readonlyNONE:0
Inherited from
Event.NONE
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8190
returnValue
returnValue:
boolean
Deprecated
Inherited from
Event.returnValue
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8135
srcElement
readonlysrcElement:EventTarget
Deprecated
Inherited from
Event.srcElement
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8141
target
readonlytarget:EventTarget
Returns the object to which event is dispatched (its target).
Inherited from
Event.target
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8147
timeStamp
readonlytimeStamp:number
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
Inherited from
Event.timeStamp
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8153
type
readonlytype:string
Returns the type of event, e.g. "click", "hashchange", or "submit".
Inherited from
Event.type
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8159
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
EventTarget[]
Inherited from
Event.composedPath
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8165
initCustomEvent()
initCustomEvent(
typeArg,canBubbleArg,cancelableArg,detailArg):void
An over-ride for the buttons value to allow setting this internally.
Parameters
• typeArg: string
• canBubbleArg: boolean
• cancelableArg: boolean
• detailArg: T
Returns
void
Defined in
packages/core/src/types/CustomEventType.ts:7
initEvent()
initEvent(
type,bubbles?,cancelable?):void
Parameters
• type: string
• bubbles?: boolean
• cancelable?: boolean
Returns
void
Deprecated
Inherited from
Event.initEvent
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8171
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
Inherited from
Event.preventDefault
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8177
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
Inherited from
Event.stopImmediatePropagation
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8183
stopPropagation()
stopPropagation():
void
When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
Returns
void
Inherited from
Event.stopPropagation
Defined in
packages/docs/node_modules/typescript/lib/lib.dom.d.ts:8189