Package dev.fritz2.dom.html

Types

open class A(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLAnchorElement> , WithText<HTMLAnchorElement>

Exposes the JavaScript HTMLAnchorElement to Kotlin

Area

open class Area(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLAreaElement> , WithText<HTMLAreaElement>

Exposes the JavaScript HTMLAreaElement to Kotlin

Audio

open class Audio(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLAudioElement> , WithText<HTMLAudioElement>

Exposes the JavaScript HTMLAudioElement to Kotlin

open class Br(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLBRElement>

Exposes the JavaScript HTMLBRElement to Kotlin

Button

open class Button(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLButtonElement> , WithText<HTMLButtonElement>

Exposes the JavaScript HTMLButtonElement to Kotlin

Canvas

open class Canvas(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLCanvasElement> , WithText<HTMLCanvasElement>

Exposes the JavaScript HTMLCanvasElement to Kotlin

Caption

open class Caption(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableCaptionElement> , WithText<HTMLTableCaptionElement>

Exposes the JavaScript HTMLTableCaptionElement to Kotlin

Col

open class Col(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableColElement> , WithText<HTMLTableColElement>

Exposes the JavaScript HTMLTableColElement to Kotlin

Colgroup

open class Colgroup(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableColElement> , WithText<HTMLTableColElement>

Exposes the JavaScript HTMLTableColElement to Kotlin

Data

open class Data(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLDataElement> , WithText<HTMLDataElement>

Exposes the JavaScript HTMLDataElement to Kotlin

DataList

open class DataList(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLDataListElement> , WithText<HTMLDataListElement>

Exposes the JavaScript HTMLDataListElement to Kotlin

Del

open class Del(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLModElement> , WithText<HTMLModElement>

Exposes the JavaScript HTMLModElement to Kotlin

Details

open class Details(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLDetailsElement> , WithText<HTMLDetailsElement>

Exposes the JavaScript HTMLDetailsElement to Kotlin

Dialog

open class Dialog(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLDialogElement> , WithText<HTMLDialogElement>

Exposes the JavaScript HTMLDialogElement to Kotlin

Div

open class Div(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLDivElement> , WithText<HTMLDivElement>

Exposes the JavaScript HTMLDivElement to Kotlin

open class Dl(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLDListElement> , WithText<HTMLDListElement>

Exposes the JavaScript HTMLDListElement to Kotlin

Embed

open class Embed(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLEmbedElement>

Exposes the JavaScript HTMLDivElement to Kotlin

Events

object Events

Contains all javascript event types.

EventType

class EventType<T : Event>(name: String)

Contains the javascript related name and actual type of the Event.

FieldSet

open class FieldSet(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLFieldSetElement>

Exposes the JavaScript HTMLFieldSetElement to Kotlin

Form

open class Form(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLFormElement> , WithText<HTMLFormElement>

Exposes the JavaScript HTMLFormElement to Kotlin

open class H(num: Int, id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLHeadingElement> , WithText<HTMLHeadingElement>

Exposes the JavaScript HTMLHeadingElement to Kotlin

open class Hr(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLHRElement>

Exposes the JavaScript HTMLHRElement to Kotlin

IFrame

open class IFrame(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLIFrameElement> , WithText<HTMLIFrameElement>

Exposes the JavaScript HTMLIFrameElement to Kotlin

Img

open class Img(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLImageElement> , WithText<HTMLImageElement>

Exposes the JavaScript HTMLImageElement to Kotlin

Input

open class Input(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLInputElement>

Exposes the JavaScript HTMLInputElement to Kotlin

Ins

open class Ins(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLModElement> , WithText<HTMLModElement>

Exposes the JavaScript HTMLModElement to Kotlin

Keys

object Keys

This object offers expressive access to predefined Shortcuts and ModifierShortcuts taken from the specification extended with Space as symbol for simple space.

Label

open class Label(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLLabelElement> , WithText<HTMLLabelElement>

Exposes the JavaScript HTMLLabelElement to Kotlin

Legend

open class Legend(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLLegendElement> , WithText<HTMLLegendElement>

Exposes the JavaScript HTMLLegendElement to Kotlin

open class Li(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLLIElement> , WithText<HTMLLIElement>

Exposes the JavaScript HTMLLIElement to Kotlin

Map

open class Map(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLMapElement> , WithText<HTMLMapElement>

Exposes the JavaScript HTMLMapElement to Kotlin

Meter

open class Meter(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLMeterElement> , WithText<HTMLMeterElement>

Exposes the JavaScript HTMLMeterElement to Kotlin

ModifierShortcut

interface ModifierShortcut

This interface models the modifier shortcuts, that enable combination of shortcuts like "STRG + F" or alike.

MountTargetNotFoundException

class MountTargetNotFoundException(message: String) : Exception

Occurs when the targeted html element is not present in document.

Object

open class Object(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLObjectElement> , WithText<HTMLObjectElement>

Exposes the JavaScript HTMLObjectElement to Kotlin

open class Ol(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLOListElement> , WithText<HTMLOListElement>

Exposes the JavaScript HTMLOListElement to Kotlin

Optgroup

open class Optgroup(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLOptGroupElement> , WithText<HTMLOptGroupElement>

Exposes the JavaScript HTMLOptGroupElement to Kotlin

Option

open class Option(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLOptionElement> , WithText<HTMLOptionElement>

Exposes the JavaScript HTMLOptionElement to Kotlin

Output

open class Output(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLOutputElement> , WithText<HTMLOutputElement>

Exposes the JavaScript HTMLOutputElement to Kotlin

open class P(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLParagraphElement> , WithText<HTMLParagraphElement>

Exposes the JavaScript HTMLParagraphElement to Kotlin

Param

open class Param(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLParamElement> , WithText<HTMLParamElement>

Exposes the JavaScript HTMLParamElement to Kotlin

Path

class Path(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<SVGPathElement>

Exposes the JavaScript Path(https://developer.mozilla.

Picture

open class Picture(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLPictureElement> , WithText<HTMLPictureElement>

Exposes the JavaScript HTMLPictureElement to Kotlin

Pre

open class Pre(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLPreElement> , WithText<HTMLPreElement>

Exposes the JavaScript HTMLPreElement to Kotlin

Progress

open class Progress(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLProgressElement> , WithText<HTMLProgressElement>

Exposes the JavaScript HTMLProgressElement to Kotlin

Quote

open class Quote(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLQuoteElement> , WithText<HTMLQuoteElement>

Exposes the JavaScript HTMLQuoteElement to Kotlin

RenderContext

interface RenderContext : WithJob, WithScope

Context for rendering static and dynamical content

Scope

class Scope(entries: HashMap<Scope.Key<*>, Any>)

Contains any type of data which consists of a Key and a corresponding value object.

ScopeContext

class ScopeContext(current: Scope)

Context for setting new entries to a Scope object.

Script

open class Script(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLScriptElement> , WithText<HTMLScriptElement>

Exposes the JavaScript HTMLScriptElement to Kotlin

Select

open class Select(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLSelectElement>

Exposes the JavaScript HTMLSelectElement to Kotlin

Shortcut

data class Shortcut(key: String, ctrl: Boolean, alt: Boolean, shift: Boolean, meta: Boolean) : ModifierShortcut

Shortcut represents a grouping type upon the "key" and the modifier key properties of a KeyboardEvent.

Span

open class Span(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLSpanElement> , WithText<HTMLSpanElement>

Exposes the JavaScript HTMLSpanElement to Kotlin

Svg

class Svg(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<SVGElement>

Exposes the JavaScript SVGElement to Kotlin

Table

open class Table(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableElement>

Exposes the JavaScript HTMLTableElement to Kotlin

TBody

open class TBody(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableSectionElement>

Exposes the JavaScript HTMLTableSectionElement to Kotlin

open class Td(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableCellElement> , WithText<HTMLTableCellElement>

Exposes the JavaScript HTMLTableCellElement to Kotlin

TextArea

open class TextArea(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTextAreaElement> , WithText<HTMLTextAreaElement>

Exposes the JavaScript HTMLTextAreaElement to Kotlin

TextElement

open class TextElement(tagName: String, id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLElement> , WithText<HTMLElement>

Special Tag for HTML5 with no attributes

TFoot

open class TFoot(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableSectionElement>

Exposes the JavaScript HTMLTableSectionElement to Kotlin

open class Th(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableCellElement> , WithText<HTMLTableCellElement>

Exposes the JavaScript HTMLTableCellElement to Kotlin

THead

open class THead(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableSectionElement>

Exposes the JavaScript HTMLTableSectionElement to Kotlin

Time

open class Time(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTimeElement> , WithText<HTMLTimeElement>

Exposes the JavaScript HTMLTimeElement to Kotlin

open class Tr(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTableRowElement> , WithText<HTMLTableRowElement>

Exposes the JavaScript HTMLTableRowElement to Kotlin

Track

open class Track(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLTrackElement> , WithText<HTMLTrackElement>

Exposes the JavaScript HTMLTrackElement to Kotlin

Transition

class Transition(enter: String?, enterStart: String?, enterEnd: String?, leave: String?, leaveStart: String?, leaveEnd: String?)

Definition of a css-transition (enter and/or leave) to be executed when a Tag is mounted to or removed from the DOM.

open class Ul(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLUListElement>

Exposes the JavaScript HTMLUListElement to Kotlin

Video

open class Video(id: String?, baseClass: String?, job: Job, scope: Scope) : Tag<HTMLVideoElement> , WithText<HTMLVideoElement>

Exposes the JavaScript HTMLVideoElement to Kotlin

WithJob

interface WithJob

Marks a class that it has a Job to start coroutines with.

WithScope

interface WithScope

Marks a class that it has Scope which can be transferred for adding/receiving additional information.

Functions

addGlobalStyle

fun addGlobalStyle(css: String)

Adds global css-rules to a fritz2-specific stylesheet added to the document when first called

addGlobalStyles

fun addGlobalStyles(css: List<String>)

Adds global css-rules to a fritz2-specific stylesheet added to the document when first called

handledBy

infix fun <A> Flow<A>.handledBy(handler: Handler<A>)

Connects a Flow to a Handler.

infix fun <A> Flow<A>.handledBy(execute: suspend (A) -> Unit): Job

Connects a Flow to a suspendable execute function.

keyOf

inline fun <T : Any> keyOf(name: String? = null): Scope.Key<T>

Creates a Scope.Key for using it in Scope.

plus

operator fun ModifierShortcut.plus(other: ModifierShortcut): ModifierShortcut

Enables combination of ModifierShortcuts like "STRG + ALT + F":

Keys.Control + Keys.Alt + "F"

render

fun render(selector: String, override: Boolean = true, content: RenderContext.() -> Unit)

Creates a RenderContext for Tags and mounts it to a constant element in the static html file which id matches the selector.

fun render(targetElement: HTMLElement? = document.body, override: Boolean = true, content: RenderContext.() -> Unit)

Creates a RenderContext for Tags and mounts it to a targetElement.

shortcutOf

fun shortcutOf(key: String): Shortcut

The function generates a Shortcut object out of a String.

fun shortcutOf(event: KeyboardEvent): Shortcut

The function generates a Shortcut object out of a KeyboardEvent.

transition

fun Tag<HTMLElement>.transition(transition: Transition)

Applies a transition (enter and/or leave) to a Tag.

fun Tag<HTMLElement>.transition(enter: String? = null, enterStart: String? = null, enterEnd: String? = null, leave: String? = null, leaveStart: String? = null, leaveEnd: String? = null)

Applies a transition (enter and/or leave) to a Tag.

Properties

FRITZ2_GLOBAL_STYLESHEET_ID

const val FRITZ2_GLOBAL_STYLESHEET_ID: String

SVG_XMLNS

const val SVG_XMLNS: String