main.web.history.PageTransitionEvent.kt Maven / Gradle / Ivy

Go to download
// Automatically generated - do not modify!

package web.history

import web.events.Event
import web.events.EventInit

external interface PageTransitionEventInit : EventInit {
    var persisted: Boolean?
}

open external class PageTransitionEvent(
    type: String,
    init: PageTransitionEventInit = definedExternally,
) : Event {
    /**
     * For the pageshow event, returns false if the page is newly being loaded (and the load event will fire). Otherwise, returns true.
     *
     * For the pagehide event, returns false if the page is going away for the last time. Otherwise, returns true, meaning that (if nothing conspires to make the page unsalvageable) the page might be reused if the user navigates back to this page.
     *
     * Things that can cause the page to be unsalvageable include:
     *
     * The user agent decided to not keep the Document alive in a session history entry after unload
     * Having iframes that are not salvageable
     * Active WebSocket objects
     * Aborting a Document
     */
    val persisted: Boolean

    companion object
}