UI Headless Runtime API - v1.0.0
    Preparing search index...

    Interface RuntimeEvent<TPayload>

    Typed cancellable lifecycle event delivered by runtime controllers.

    interface RuntimeEvent<TPayload> {
        defaultPrevented: boolean;
        detail: Readonly<TPayload>;
        preventDefault(): void;
    }

    Type Parameters

    • TPayload
    Index

    Properties

    defaultPrevented: boolean

    Whether a listener cancelled the pending transition.

    detail: Readonly<TPayload>

    Event payload supplied by the controller.

    Methods

    • Cancels a before* transition. Calling this for informational events is harmless.

      Returns void