Package-level declarations

Types

interface AddEventListenerOptions : EventListenerOptions, Abortable

open class CustomEvent<out D : JsAny?>(val type: EventType<CustomEvent<D>>, init: CustomEventInit<D> = definedExternally) : Event

The CustomEvent interface can be used to attach custom data to an event generated by an application.

CustomEventInit

interface CustomEventInit<D : JsAny?> : EventInit

MDN Reference

Event

open class Event(val type: EventType<Event>, init: EventInit = definedExternally)

The Event interface represents an event which takes place on an EventTarget.

EventHandler

sealed interface EventHandler<in E : Event, out C : EventTarget, out T : EventTarget>

EventInit

interface EventInit

MDN Reference

EventInstance

class EventInstance<out E : Event, out C : EventTarget, out T : EventTarget>(target: C, type: EventType<E>)

EventListenerOptions

interface EventListenerOptions

EventPhase

sealed interface EventPhase

EventTarget

open class EventTarget

The EventTarget interface is implemented by objects that can receive events and may have listeners for them.

EventType

sealed interface EventType<out E : Event>

HasTargets

interface HasTargets<out C : EventTarget, out T : EventTarget>

JsEvent

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class JsEvent(val type: String)

ObservableEventListenerOptions

interface ObservableEventListenerOptions

ProgressEvent

open class ProgressEvent(val type: EventType<ProgressEvent>, init: ProgressEventInit = definedExternally) : Event

The ProgressEvent interface represents events that measure the progress of an underlying process, like an HTTP request (e.g., an XMLHttpRequest, or the loading of the underlying resource of an img, audio, video, style or link).

ProgressEventInit

interface ProgressEventInit : EventInit

MDN Reference

Properties

ABORT

val Event.Companion.ABORT: EventType<Event>

val ProgressEvent.Companion.ABORT: EventType<ProgressEvent>

ADD_SOURCE_BUFFER

val Event.Companion.ADD_SOURCE_BUFFER: EventType<Event>

AFTER_PRINT

val Event.Companion.AFTER_PRINT: EventType<Event>

BEFORE_MATCH

val Event.Companion.BEFORE_MATCH: EventType<Event>

BEFORE_PRINT

val Event.Companion.BEFORE_PRINT: EventType<Event>

BUFFERED_AMOUNT_LOW

val Event.Companion.BUFFERED_AMOUNT_LOW: EventType<Event>

CAN_PLAY

val Event.Companion.CAN_PLAY: EventType<Event>

CAN_PLAY_THROUGH

val Event.Companion.CAN_PLAY_THROUGH: EventType<Event>

CANCEL

val Event.Companion.CANCEL: EventType<Event>

CHANGE

val Event.Companion.CHANGE: EventType<Event>

CLICK

val Event.Companion.CLICK: EventType<Event>

val Event.Companion.CLOSE: EventType<Event>

CLOSING

val Event.Companion.CLOSING: EventType<Event>

COMPLETE

val Event.Companion.COMPLETE: EventType<Event>

CONNECT

val Event.Companion.CONNECT: EventType<Event>

CONNECTING

val Event.Companion.CONNECTING: EventType<Event>

CONNECTION_STATE_CHANGE

val Event.Companion.CONNECTION_STATE_CHANGE: EventType<Event>

CONTEXT_LOST

val Event.Companion.CONTEXT_LOST: EventType<Event>

CONTEXT_RESTORED

val Event.Companion.CONTEXT_RESTORED: EventType<Event>

CONTROLLER_CHANGE

val Event.Companion.CONTROLLER_CHANGE: EventType<Event>

CUE_CHANGE

val Event.Companion.CUE_CHANGE: EventType<Event>

DEQUEUE

val Event.Companion.DEQUEUE: EventType<Event>

DEVICE_CHANGE

val Event.Companion.DEVICE_CHANGE: EventType<Event>

DISCONNECT

val Event.Companion.DISCONNECT: EventType<Event>

DISPOSE

val Event.Companion.DISPOSE: EventType<Event>

DOM_CONTENT_LOADED

val Event.Companion.DOM_CONTENT_LOADED: EventType<Event>

DURATION_CHANGE

val Event.Companion.DURATION_CHANGE: EventType<Event>

EMPTIED

val Event.Companion.EMPTIED: EventType<Event>

ENDED

val Event.Companion.ENDED: EventType<Event>

ENTER

val Event.Companion.ENTER: EventType<Event>

ERROR

val Event.Companion.ERROR: EventType<Event>

val ProgressEvent.Companion.ERROR: EventType<ProgressEvent>

EXIT

val Event.Companion.EXIT: EventType<Event>

FULLSCREEN_CHANGE

val Event.Companion.FULLSCREEN_CHANGE: EventType<Event>

FULLSCREEN_ERROR

val Event.Companion.FULLSCREEN_ERROR: EventType<Event>

GATHERING_STATE_CHANGE

val Event.Companion.GATHERING_STATE_CHANGE: EventType<Event>

ICE_CONNECTION_STATE_CHANGE

val Event.Companion.ICE_CONNECTION_STATE_CHANGE: EventType<Event>

ICE_GATHERING_STATE_CHANGE

val Event.Companion.ICE_GATHERING_STATE_CHANGE: EventType<Event>

INVALID

val Event.Companion.INVALID: EventType<Event>

KEY_STATUSES_CHANGE

val Event.Companion.KEY_STATUSES_CHANGE: EventType<Event>

LANGUAGE_CHANGE

val Event.Companion.LANGUAGE_CHANGE: EventType<Event>

LOAD

val Event.Companion.LOAD: EventType<Event>

val ProgressEvent.Companion.LOAD: EventType<ProgressEvent>

LOAD_END

val ProgressEvent.Companion.LOAD_END: EventType<ProgressEvent>

LOAD_START

val Event.Companion.LOAD_START: EventType<Event>

val ProgressEvent.Companion.LOAD_START: EventType<ProgressEvent>

LOADED_DATA

val Event.Companion.LOADED_DATA: EventType<Event>

LOADED_METADATA

val Event.Companion.LOADED_METADATA: EventType<Event>

MUTE

val Event.Companion.MUTE: EventType<Event>

NEGOTIATION_NEEDED

val Event.Companion.NEGOTIATION_NEEDED: EventType<Event>

OFFLINE

val Event.Companion.OFFLINE: EventType<Event>

ONLINE

val Event.Companion.ONLINE: EventType<Event>

OPEN

val Event.Companion.OPEN: EventType<Event>

PAUSE

val Event.Companion.PAUSE: EventType<Event>

PLAY

val Event.Companion.PLAY: EventType<Event>

PLAYING

val Event.Companion.PLAYING: EventType<Event>

POINTER_LOCK_CHANGE

val Event.Companion.POINTER_LOCK_CHANGE: EventType<Event>

POINTER_LOCK_ERROR

val Event.Companion.POINTER_LOCK_ERROR: EventType<Event>

POINTER_RAW_UPDATE

val Event.Companion.POINTER_RAW_UPDATE: EventType<Event>

PROGRESS

val ProgressEvent.Companion.PROGRESS: EventType<ProgressEvent>

RATE_CHANGE

val Event.Companion.RATE_CHANGE: EventType<Event>

READY_STATE_CHANGE

val Event.Companion.READY_STATE_CHANGE: EventType<Event>

RELEASE

val Event.Companion.RELEASE: EventType<Event>

REMOVE_SOURCE_BUFFER

val Event.Companion.REMOVE_SOURCE_BUFFER: EventType<Event>

RESET

val Event.Companion.RESET: EventType<Event>

RESIZE

val Event.Companion.RESIZE: EventType<Event>

RESOURCE_TIMING_BUFFER_FULL

val Event.Companion.RESOURCE_TIMING_BUFFER_FULL: EventType<Event>

RESUME

val Event.Companion.RESUME: EventType<Event>

SCROLL

val Event.Companion.SCROLL: EventType<Event>

SCROLL_END

val Event.Companion.SCROLL_END: EventType<Event>

SEEKED

val Event.Companion.SEEKED: EventType<Event>

SEEKING

val Event.Companion.SEEKING: EventType<Event>

SELECT

val Event.Companion.SELECT: EventType<Event>

SELECT_START

val Event.Companion.SELECT_START: EventType<Event>

SELECTED_CANDIDATE_PAIR_CHANGE

val Event.Companion.SELECTED_CANDIDATE_PAIR_CHANGE: EventType<Event>

SELECTION_CHANGE

val Event.Companion.SELECTION_CHANGE: EventType<Event>

SHOW

val Event.Companion.SHOW: EventType<Event>

SIGNALING_STATE_CHANGE

val Event.Companion.SIGNALING_STATE_CHANGE: EventType<Event>

SLOT_CHANGE

val Event.Companion.SLOT_CHANGE: EventType<Event>

SOURCE_CLOSE

val Event.Companion.SOURCE_CLOSE: EventType<Event>

SOURCE_ENDED

val Event.Companion.SOURCE_ENDED: EventType<Event>

SOURCE_OPEN

val Event.Companion.SOURCE_OPEN: EventType<Event>

STALLED

val Event.Companion.STALLED: EventType<Event>

START

val Event.Companion.START: EventType<Event>

STATE_CHANGE

val Event.Companion.STATE_CHANGE: EventType<Event>

STOP

val Event.Companion.STOP: EventType<Event>

SUCCESS

val Event.Companion.SUCCESS: EventType<Event>

SUSPEND

val Event.Companion.SUSPEND: EventType<Event>

TIME_UPDATE

val Event.Companion.TIME_UPDATE: EventType<Event>

TIMEOUT

val ProgressEvent.Companion.TIMEOUT: EventType<ProgressEvent>

UNLOAD

val Event.Companion.UNLOAD: EventType<Event>

UNMUTE

val Event.Companion.UNMUTE: EventType<Event>

UPDATE

val Event.Companion.UPDATE: EventType<Event>

UPDATE_END

val Event.Companion.UPDATE_END: EventType<Event>

UPDATE_FOUND

val Event.Companion.UPDATE_FOUND: EventType<Event>

UPDATE_START

val Event.Companion.UPDATE_START: EventType<Event>

VISIBILITY_CHANGE

val Event.Companion.VISIBILITY_CHANGE: EventType<Event>

VOICES_CHANGED

val Event.Companion.VOICES_CHANGED: EventType<Event>

VOLUME_CHANGE

val Event.Companion.VOLUME_CHANGE: EventType<Event>

WAITING

val Event.Companion.WAITING: EventType<Event>

WAITING_FOR_KEY

val Event.Companion.WAITING_FOR_KEY: EventType<Event>

Functions

addEventHandler

fun <E : Event, C : EventTarget, D : E, HasTargets<C, EventTarget>> C.addEventHandler(type: EventType<E>, handler: (D) -> Unit): () -> Unit

fun <E : Event, C : EventTarget, T : EventTarget> C.addEventHandler(type: EventType<E>, handler: EventHandler<E, C, T>): () -> Unit

fun <E : Event, C : EventTarget, D : E, HasTargets<C, EventTarget>> C.addEventHandler(type: EventType<E>, options: AddEventListenerOptions?, handler: (D) -> Unit): () -> Unit

fun <E : Event, C : EventTarget, T : EventTarget> C.addEventHandler(type: EventType<E>, options: AddEventListenerOptions?, handler: EventHandler<E, C, T>): () -> Unit

addEventListener

fun <E : Event, C : EventTarget> C.addEventListener(type: EventType<E>, handler: (E) -> Unit, options: AddEventListenerOptions? = undefined)

fun <E : Event, C : EventTarget, T : EventTarget> C.addEventListener(type: EventType<E>, handler: EventHandler<E, C, T>, options: AddEventListenerOptions? = undefined)

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

addHandler

fun <E : Event, C : EventTarget, T : EventTarget, D : E, HasTargets<C, T>> EventInstance<E, C, T>.addHandler(handler: (D) -> Unit): () -> Unit

fun <E : Event, C : EventTarget, T : EventTarget, D : E, HasTargets<C, T>> EventInstance<E, C, T>.addHandler(options: AddEventListenerOptions?, handler: (D) -> Unit): () -> Unit

fun <E : Event, C : EventTarget, T : EventTarget> EventInstance<E, C, T>.addHandler(handler: EventHandler<E, C, T>, options: AddEventListenerOptions? = undefined): () -> Unit

asInit

inline fun <D : JsAny?> CustomEvent<D>.asInit(): CustomEventInit<D>

inline fun Event.asInit(): EventInit

inline fun ProgressEvent.asInit(): ProgressEventInit

EventHandler

inline fun EventHandler(noinline handler: () -> Unit): EventHandler<Event, Nothing, Nothing>

inline fun <E : Event, C : EventTarget, T : EventTarget, D : E, HasTargets<C, T>> EventHandler(noinline handler: (D) -> Unit): EventHandler<E, C, T>

EventInstance

inline fun <E : Event, C : EventTarget, T : EventTarget> EventInstance(target: C, type: String): EventInstance<E, C, T>

EventType

inline fun <E : Event> EventType(value: String): EventType<E>

invoke

operator fun <E : Event, C : EventTarget, T : EventTarget, D : E, HasTargets<C, T>> EventInstance<E, C, T>.invoke(capture: Boolean? = null, passive: Boolean? = null): Flow<D>

removeEventListener

fun <E : Event, C : EventTarget> C.removeEventListener(type: EventType<E>, handler: (E) -> Unit, options: AddEventListenerOptions? = undefined)

fun <E : Event, C : EventTarget, T : EventTarget> C.removeEventListener(type: EventType<E>, handler: EventHandler<E, C, T>, options: AddEventListenerOptions? = undefined)

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

suspend fun <E : Event> Flow<E>.subscribe(handler: (E) -> Unit): Job