Skip to content

pantoken / renderers/web-components/src / CommandEventish

Interface: CommandEventish

Alpha

The command/source shape of an Invoker Commands CommandEvent (not yet in the DOM lib types).

Extends

  • Event

Properties

command

command: string

Alpha


source

source: Element | null

Alpha


bubbles

readonly bubbles: boolean

Alpha

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

Inherited from

Event.bubbles


cancelBubble

cancelBubble: boolean

Alpha

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

Deprecated

MDN Reference

Inherited from

Event.cancelBubble


cancelable

readonly cancelable: boolean

Alpha

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

Inherited from

Event.cancelable


composed

readonly composed: boolean

Alpha

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

Inherited from

Event.composed


currentTarget

readonly currentTarget: EventTarget | null

Alpha

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

Inherited from

Event.currentTarget


defaultPrevented

readonly defaultPrevented: boolean

Alpha

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

Inherited from

Event.defaultPrevented


eventPhase

readonly eventPhase: number

Alpha

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

MDN Reference

Inherited from

Event.eventPhase


isTrusted

readonly isTrusted: boolean

Alpha

The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

Inherited from

Event.isTrusted


returnValue

returnValue: boolean

Alpha

The Event property returnValue indicates whether the default action for this event has been prevented or not.

Deprecated

MDN Reference

Inherited from

Event.returnValue


srcElement

readonly srcElement: EventTarget | null

Alpha

The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.

Deprecated

MDN Reference

Inherited from

Event.srcElement


target

readonly target: EventTarget | null

Alpha

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

MDN Reference

Inherited from

Event.target


timeStamp

readonly timeStamp: number

Alpha

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

Inherited from

Event.timeStamp


type

readonly type: string

Alpha

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

MDN Reference

Inherited from

Event.type


NONE

readonly NONE: 0

Alpha

Inherited from

Event.NONE


CAPTURING_PHASE

readonly CAPTURING_PHASE: 1

Alpha

Inherited from

Event.CAPTURING_PHASE


AT_TARGET

readonly AT_TARGET: 2

Alpha

Inherited from

Event.AT_TARGET


BUBBLING_PHASE

readonly BUBBLING_PHASE: 3

Alpha

Inherited from

Event.BUBBLING_PHASE

Methods

composedPath()

composedPath(): EventTarget[]

Alpha

The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

MDN Reference

Returns

EventTarget[]

Inherited from

Event.composedPath


initEvent()

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

Alpha

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

Parameters

type

string

bubbles?

boolean

cancelable?

boolean

Returns

void

Deprecated

MDN Reference

Inherited from

Event.initEvent


preventDefault()

preventDefault(): void

Alpha

The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

MDN Reference

Returns

void

Inherited from

Event.preventDefault


stopImmediatePropagation()

stopImmediatePropagation(): void

Alpha

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

MDN Reference

Returns

void

Inherited from

Event.stopImmediatePropagation


stopPropagation()

stopPropagation(): void

Alpha

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

MDN Reference

Returns

void

Inherited from

Event.stopPropagation