kweb-core/kweb.html/Document

Document

class Document(val receiver: WebBrowser) : EventGenerator<Document> (source)

Represents the in-browser Document Object Model, corresponding to the JavaScript document object.

Passed in as doc to the buildPage lambda of the Kweb constructor.

Constructors

constructor(receiver: WebBrowser)

Properties

val body: BodyElement

open override val browser: WebBrowser

val cookie: CookieReceiver

Returns a CookieReceiver which can be used to read and write cookies, note that localStorage is a more modern alternative to this mechanism.

val head: HeadElement

val localStorage: StorageReceiver

Allows data to be stored in and retrieved from the browser's local storage.

val on: OnReceiver<Document>

See here.

val onImmediate: OnImmediateReceiver<Document>

See here.

val receiver: WebBrowser

val sessionStorage: StorageReceiver

Allows data to be stored in and retrieved from the browser's session storage.

Functions

addEventListener

open override fun addEventListener(eventName: String, returnEventFields: Set<String>, retrieveJs: String?, preventDefault: Boolean, callback: (JsonElement) -> Unit): Document

addImmediateEventCode

open override fun addImmediateEventCode(eventName: String, jsCode: String)

fun body(new: ElementCreator<BodyElement>.(BodyElement) -> Unit? = null): BodyElement

fun execCommand(command: String)

fun getElementById(id: String): Element

suspend fun getOrigin(): Any

fun head(new: ElementCreator<HeadElement>.(HeadElement) -> Unit? = null): HeadElement

fun on(retrieveJs: String? = null, preventDefault: Boolean = false): OnReceiver<Document>

You can supply a javascript expression retrieveJs which will be available via Event.retrieveJs