kotlin-web/web.events

Package-level declarations

Types

AddEventListenerOptions

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

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

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

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

interface EventInit

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

EventListenerOptions

interface EventListenerOptions

sealed interface EventPhase

open class EventTarget

sealed interface EventType<out E : Event>

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

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class JsEvent(val type: String)

ObservableEventListenerOptions

interface ObservableEventListenerOptions

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

Properties

val Event.Companion.ABORT: EventType<Event>

val ProgressEvent.Companion.ABORT: EventType<ProgressEvent>

ADD_SOURCE_BUFFER

val Event.Companion.ADD_SOURCE_BUFFER: EventType<Event>

val Event.Companion.AFTER_PRINT: EventType<Event>

val Event.Companion.BEFORE_MATCH: EventType<Event>

val Event.Companion.BEFORE_PRINT: EventType<Event>

BUFFERED_AMOUNT_LOW

val Event.Companion.BUFFERED_AMOUNT_LOW: EventType<Event>

val Event.Companion.CAN_PLAY: EventType<Event>

CAN_PLAY_THROUGH

val Event.Companion.CAN_PLAY_THROUGH: EventType<Event>

val Event.Companion.CANCEL: EventType<Event>

val Event.Companion.CHANGE: EventType<Event>

val Event.Companion.CLICK: EventType<Event>

val Event.Companion.CLOSE: EventType<Event>

val Event.Companion.CLOSING: EventType<Event>

val Event.Companion.COMPLETE: EventType<Event>

val Event.Companion.CONNECT: EventType<Event>

val Event.Companion.CONNECTING: EventType<Event>

CONNECTION_STATE_CHANGE

val Event.Companion.CONNECTION_STATE_CHANGE: EventType<Event>

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>

val Event.Companion.CUE_CHANGE: EventType<Event>

val Event.Companion.DEQUEUE: EventType<Event>

val Event.Companion.DEVICE_CHANGE: EventType<Event>

val Event.Companion.DISCONNECT: EventType<Event>

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>

val Event.Companion.EMPTIED: EventType<Event>

val Event.Companion.ENDED: EventType<Event>

val Event.Companion.ENTER: EventType<Event>

val Event.Companion.ERROR: EventType<Event>

val ProgressEvent.Companion.ERROR: EventType<ProgressEvent>

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>

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>

val Event.Companion.LOAD: EventType<Event>

val ProgressEvent.Companion.LOAD: EventType<ProgressEvent>

val ProgressEvent.Companion.LOAD_END: EventType<ProgressEvent>

val Event.Companion.LOAD_START: EventType<Event>

val ProgressEvent.Companion.LOAD_START: EventType<ProgressEvent>

val Event.Companion.LOADED_DATA: EventType<Event>

LOADED_METADATA

val Event.Companion.LOADED_METADATA: EventType<Event>

val Event.Companion.MUTE: EventType<Event>

NEGOTIATION_NEEDED

val Event.Companion.NEGOTIATION_NEEDED: EventType<Event>

val Event.Companion.OFFLINE: EventType<Event>

val Event.Companion.ONLINE: EventType<Event>

val Event.Companion.OPEN: EventType<Event>

val Event.Companion.PAUSE: EventType<Event>

val Event.Companion.PLAY: EventType<Event>

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>

val ProgressEvent.Companion.PROGRESS: EventType<ProgressEvent>

val Event.Companion.RATE_CHANGE: EventType<Event>

READY_STATE_CHANGE

val Event.Companion.READY_STATE_CHANGE: EventType<Event>

val Event.Companion.RELEASE: EventType<Event>

REMOVE_SOURCE_BUFFER

val Event.Companion.REMOVE_SOURCE_BUFFER: EventType<Event>

val Event.Companion.RESET: EventType<Event>

val Event.Companion.RESIZE: EventType<Event>

RESOURCE_TIMING_BUFFER_FULL

val Event.Companion.RESOURCE_TIMING_BUFFER_FULL: EventType<Event>

val Event.Companion.RESUME: EventType<Event>

val Event.Companion.SCROLL: EventType<Event>

val Event.Companion.SCROLL_END: EventType<Event>

val Event.Companion.SEEKED: EventType<Event>

val Event.Companion.SEEKING: EventType<Event>

val Event.Companion.SELECT: EventType<Event>

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>

val Event.Companion.SHOW: EventType<Event>

SIGNALING_STATE_CHANGE

val Event.Companion.SIGNALING_STATE_CHANGE: EventType<Event>

val Event.Companion.SLOT_CHANGE: EventType<Event>

val Event.Companion.SOURCE_CLOSE: EventType<Event>

val Event.Companion.SOURCE_ENDED: EventType<Event>

val Event.Companion.SOURCE_OPEN: EventType<Event>

val Event.Companion.STALLED: EventType<Event>

val Event.Companion.START: EventType<Event>

val Event.Companion.STATE_CHANGE: EventType<Event>

val Event.Companion.STOP: EventType<Event>

val Event.Companion.SUCCESS: EventType<Event>

val Event.Companion.SUSPEND: EventType<Event>

val Event.Companion.TIME_UPDATE: EventType<Event>

val ProgressEvent.Companion.TIMEOUT: EventType<ProgressEvent>

val Event.Companion.UNLOAD: EventType<Event>

val Event.Companion.UNMUTE: EventType<Event>

val Event.Companion.UPDATE: EventType<Event>

val Event.Companion.UPDATE_END: EventType<Event>

val Event.Companion.UPDATE_FOUND: EventType<Event>

val Event.Companion.UPDATE_START: EventType<Event>

VISIBILITY_CHANGE

val Event.Companion.VISIBILITY_CHANGE: EventType<Event>

val Event.Companion.VOICES_CHANGED: EventType<Event>

val Event.Companion.VOLUME_CHANGE: EventType<Event>

val Event.Companion.WAITING: EventType<Event>

WAITING_FOR_KEY

val Event.Companion.WAITING_FOR_KEY: EventType<Event>

WEBKIT_ANIMATION_END

val Event.Companion.WEBKIT_ANIMATION_END: EventType<Event>

WEBKIT_ANIMATION_ITERATION

val Event.Companion.WEBKIT_ANIMATION_ITERATION: EventType<Event>

WEBKIT_ANIMATION_START

val Event.Companion.WEBKIT_ANIMATION_START: EventType<Event>

WEBKIT_FULLSCREEN_CHANGE

val Event.Companion.WEBKIT_FULLSCREEN_CHANGE: EventType<Event>

WEBKIT_TRANSITION_END

val Event.Companion.WEBKIT_TRANSITION_END: 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)

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

fun <E : Event, T : EventTarget, D : E, HasTargets<*, T>> EventInstance<E, *, T>.asFlow(): Flow<D>

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

inline fun Event.asInit(): EventInit

inline fun ProgressEvent.asInit(): ProgressEventInit

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>

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

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

suspend operator fun <E : Event, T : EventTarget, D : E, HasTargets<*, T>> EventInstance<E, *, T>.iterator(): SuspendIterator<D>

suspend fun <E : Event, C : EventTarget, T : EventTarget, D : E, HasTargets<C, T>> EventInstance<E, C, T>.once(): 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)

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

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

suspend fun <E : Event, C : EventTarget, T : EventTarget> EventInstance<E, C, T>.subscribe(handler: EventHandler<E, C, T>, options: AddEventListenerOptions? = undefined): Job