Interface ComponentEvent

Definition of a single event of a component.

interface ComponentEvent {
    cancelable?: boolean;
    description: string;
    name: string;
    pairedEvent?: string;
    parameters?: ComponentEventParameter[];
}

Index

Properties

cancelable? description name pairedEvent? parameters?

Properties

`Optional`cancelable

cancelable?: boolean

Whether this is a cancelable "before" event

description

description: string

A description of what this event does

name

name: string

The name of the event

`Optional`pairedEvent

pairedEvent?: string

The paired "after" event name (if this is a "before" event)

`Optional`parameters

parameters?: ComponentEventParameter[]

An array of parameters that this event can emit.