kvision/io.kvision.html/Code

Code

open class Code(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Code.() -> Unit? = null) : Tag(source)

Simple component rendered as code.

Parameters

content

element text

rich

determines if content can contain HTML code

align

content align

className

CSS class names

init

an initializer extension function

Constructors

Code

constructor(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Code.() -> Unit? = null)

Properties

align

var align: Align?

Text align.

alignContent

open var alignContent: AlignContent?

CSS flexbox/grid content alignment.

alignItems

open var alignItems: AlignItems?

CSS flexbox/grid items alignment.

alignSelf

open var alignSelf: AlignItems?

CSS flexbox items self-alignment.

background

open var background: Background?

Background of the current component.

border

open var border: Border?

Border of the current component.

borderBottom

open var borderBottom: Border?

Bottom border of the current component.

borderLeft

open var borderLeft: Border?

Left border of the current component.

borderRadius

open var borderRadius: CssSize?

CSS border radius.

borderRadiusList

open var borderRadiusList: List<CssSize>?

List of CSS border radius values.

borderRight

open var borderRight: Border?

Right border of the current component.

borderTop

open var borderTop: Border?

Top border of the current component.

bottom

open var bottom: CssSize?

Bottom edge of the current component.

boxShadow

open var boxShadow: BoxShadow?

Box shadow of the current component.

boxShadowList

open var boxShadowList: List<BoxShadow>?

List of box shadows of the current component.

clear

open var clear: Clear?

CSS clear float of the current component.

color

open var color: Color?

Text color for the current component.

colorHex

open var colorHex: Int?

Text color for the current component given in hex format (write only).

colorName

open var colorName: Col?

Text color for the current component given with named constant (write only).

content

open override var content: String?

Text content of the tag.

cursor

open var cursor: Cursor?

CSS cursor shape over the current component.

display

open var display: Display?

CSS display of the current component.

draggable

var draggable: Boolean?

Determines if the current widget is draggable.

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

CSS flexbox item basis.

flexDirection

open var flexDirection: FlexDirection?

CSS flexbox direction.

flexGrow

open var flexGrow: Int?

CSS flexbox item grow.

flexShrink

open var flexShrink: Int?

CSS flexbox item shrink.

flexWrap

open var flexWrap: FlexWrap?

CSS flexbox wrap mode.

float

open var float: PosFloat?

CSS position float of the current component.

fontFamily

open var fontFamily: String?

CSS font family of the current component.

fontSize

open var fontSize: CssSize?

CSS font size of the current component.

fontStyle

open var fontStyle: FontStyle?

CSS font style of the current component.

fontVariant

open var fontVariant: FontVariant?

CSS font variant of the current component.

fontWeight

open var fontWeight: FontWeight?

CSS font weight of the current component.

gridArea

open var gridArea: String?

CSS grid area.

gridAutoColumns

open var gridAutoColumns: String?

CSS grid auto columns.

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

CSS grid auto flow.

gridAutoRows

open var gridAutoRows: String?

CSS grid auto rows.

gridColumnEnd

open var gridColumnEnd: String?

CSS grid column end.

gridColumnGap

open var gridColumnGap: Int?

CSS grid column gap.

gridColumnStart

open var gridColumnStart: Int?

CSS grid column start.

gridRowEnd

open var gridRowEnd: String?

CSS grid row end.

gridRowGap

open var gridRowGap: Int?

CSS grid row gap.

gridRowStart

open var gridRowStart: Int?

CSS grid row start.

gridTemplateAreas

open var gridTemplateAreas: List<String>?

CSS grid areas template.

gridTemplateColumns

open var gridTemplateColumns: String?

CSS grid columns template.

gridTemplateRows

open var gridTemplateRows: String?

CSS grid rows template.

height

open var height: CssSize?

Height of the current component.

var id: String?

An ID attribute of generated HTML element.

justifyContent

open var justifyContent: JustifyContent?

CSS flexbox/grid content justification.

justifyItems

open var justifyItems: JustifyItems?

CSS grid items justification.

justifySelf

open var justifySelf: JustifyItems?

CSS grid items self-justification.

kvscope

var kvscope: dynamic

left

open var left: CssSize?

Left edge of the current component.

letterSpacing

open var letterSpacing: CssSize?

CSS Text letter spacing of the current component.

lineBreak

open var lineBreak: LineBreak?

CSS line break of the current component.

lineHeight

open var lineHeight: CssSize?

CSS Text line height of the current component.

listStyle

open var listStyle: ListStyle?

List style of the current component.

margin

open var margin: CssSize?

Margin of the current component.

marginBottom

open var marginBottom: CssSize?

Bottom margin of the current component.

marginLeft

open var marginLeft: CssSize?

Left margin of the current component.

marginRight

open var marginRight: CssSize?

Right margin of the current component.

marginTop

open var marginTop: CssSize?

Top margin of the current component.

maxHeight

open var maxHeight: CssSize?

Maximal height of the current component.

maxWidth

open var maxWidth: CssSize?

Maximal width of the current component.

minHeight

open var minHeight: CssSize?

Minimal height of the current component.

minWidth

open var minWidth: CssSize?

Minimal width of the current component.

opacity

open var opacity: Double?

Opacity of the current component.

order

open var order: Int?

CSS flexbox item order.

outline

open var outline: Outline?

Outline of the current component.

overflow

open var overflow: Overflow?

CSS overflow of the current component.

overflowWrap

open var overflowWrap: OverflowWrap?

CSS overflow-wrap of the current component.

overflowX

open var overflowX: Overflow?

CSS overflow-x of the current component.

overflowY

open var overflowY: Overflow?

CSS overflow-y of the current component.

padding

open var padding: CssSize?

Padding of the current component.

paddingBottom

open var paddingBottom: CssSize?

Bottom padding of the current component.

paddingLeft

open var paddingLeft: CssSize?

Left padding of the current component.

paddingRight

open var paddingRight: CssSize?

Right padding of the current component.

paddingTop

open var paddingTop: CssSize?

Top padding of the current component.

parent

open override var parent: Container?

Parent of the current component.

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

CSS position of the current component.

resize

open var resize: Resize?

CSS resize of the current component.

rich

open override var rich: Boolean

Determines if content can contain HTML code.

right

open var right: CssSize?

Right edge of the current component.

role

var role: String?

A role attribute of generated HTML element.

tabindex

var tabindex: Int?

A tabindex attribute of generated HTML element.

template

open override var template: (Any?) -> String?

Handlebars template.

templateData

open var templateData: Any?

Handlebars template data object.

templates

open override var templates: Map<String, (Any?) -> String>

Handlebars templates for i18n.

textAlign

open var textAlign: TextAlign?

CSS Text align of the current component.

textDecoration

open var textDecoration: TextDecoration?

CSS Text decoration of the current component.

textDirection

open var textDirection: Direction?

CSS Text direction of the current component.

textIndent

open var textIndent: CssSize?

CSS Text indent of the current component.

textOverflow

open var textOverflow: TextOverflow?

CSS Text overflow of the current component.

textShadow

open var textShadow: TextShadow?

CSS Text shadow of the current component.

textTransform

open var textTransform: TextTransform?

CSS Text transform of the current component.

title

var title: String?

A title attribute of generated HTML element.

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

Top edge of the current component.

transition

open var transition: Transition?

CSS transition effect for the current component.

transitionList

open var transitionList: List<Transition>?

List of CSS transition effects for the current component.

type

var type: TAG

Tag type.

unicodeBidi

open var unicodeBidi: UnicodeBidi?

CSS Text unicode-bidi of the current component.

verticalAlign

open var verticalAlign: VerticalAlign?

CSS Text vertical align of the current component.

visible

open override var visible: Boolean

Visibility state of the current component.

whiteSpace

open var whiteSpace: WhiteSpace?

CSS Text white space of the current component.

width

open var width: CssSize?

Width of the current component.

wordBreak

open var wordBreak: WordBreak?

CSS word break of the current component.

wordSpacing

open var wordSpacing: CssSize?

CSS Text word spacing of the current component.

zIndex

open var zIndex: Int?

Z-index of the current component.

Functions

add

open override fun add(child: Component)

Adds given component to the current container.

open override fun add(position: Int, child: Component)

Adds given component to the current container at the given position.

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

The supplied function is called after the widget DOM element is created.

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

The supplied function is called after the widget is removed from the DOM.

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

The supplied function is called after the widget is inserted into the DOM.

addAll

open override fun addAll(children: List<Component>)

Adds a list of components to the current container.

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

The supplied function is called before the widget is disposed.

addCssClass

open override fun addCssClass(css: String)

Adds given value to the set of CSS classes generated in html code of current component.

addCssStyle

open override fun addCssStyle(css: Style)

Adds given style object to the set of CSS classes generated in html code of current component.

address

fun Container.address(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Address.() -> Unit? = null): Address

DSL builder extension function.

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

Adds given value to the set of CSS classes generated in html code of parent component.

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

Adds given style object to the set of CSS classes generated in html code of parent component.

article

fun Container.article(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Article.() -> Unit? = null): Article

DSL builder extension function.

fun Container.b(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: B.() -> Unit? = null): B

DSL builder extension function.

blur

open fun blur()

Makes the element blur.

fun Container.br(className: String? = null, init: Br.() -> Unit? = null): Br

DSL builder extension function.

button

fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, separator: String? = null, labelFirst: Boolean = true, className: String? = null, init: Button.() -> Unit? = null): Button

DSL builder extension function.

canvas

fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, className: String? = null, init: Canvas.() -> Unit? = null): Canvas

DSL builder extension function.

checkBox

fun Container.checkBox(value: Boolean = false, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: CheckBox.() -> Unit? = null): CheckBox

DSL builder extension function.

checkBoxInput

fun Container.checkBoxInput(value: Boolean = false, className: String? = null, init: CheckBoxInput.() -> Unit? = null): CheckBoxInput

DSL builder extension function.

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

Remove all after create hooks functions.

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

Remove all after destroy hooks functions.

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

Remove all after insert hooks functions.

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

Remove all before dispose hooks functions.

clearDragDropData

open fun clearDragDropData()

Clears D&D data for the current widget. It also makes it not draggable.

code

fun Container.code(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Code.() -> Unit? = null): Code

DSL builder extension function.

customTag

fun Container.customTag(elementName: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: CustomTag.() -> Unit? = null): CustomTag

DSL builder extension function.

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

Dispatches a custom event.

disposeAll

open override fun disposeAll()

Removes all children from the current container and disposes them.

div

fun Container.div(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Div.() -> Unit? = null): Div

DSL builder extension function.

dockPanel

fun Container.dockPanel(className: String? = null, init: DockPanel.() -> Unit? = null): DockPanel

DSL builder extension function.

fun Container.em(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Em.() -> Unit? = null): Em

DSL builder extension function.

fieldLabel

fun Container.fieldLabel(forId: String, content: String? = null, rich: Boolean = false, className: String? = null, init: FieldLabel.() -> Unit? = null): FieldLabel

DSL builder extension function.

fieldset

fun Container.fieldset(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Fieldset.() -> Unit? = null): Fieldset

DSL builder extension function.

fieldsetPanel

fun Container.fieldsetPanel(legend: String? = null, className: String? = null, init: FieldsetPanel.() -> Unit? = null): FieldsetPanel

DSL builder extension function.

figcaption

fun Container.figcaption(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figcaption.() -> Unit? = null): Figcaption

DSL builder extension function.

figure

fun Container.figure(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figure.() -> Unit? = null): Figure

DSL builder extension function.

flexPanel

fun Container.flexPanel(direction: FlexDirection? = null, wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, alignContent: AlignContent? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: FlexPanel.() -> Unit? = null): FlexPanel

DSL builder extension function.

focus

open override fun focus()

Makes the element focused.

footer

fun Container.footer(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Footer.() -> Unit? = null): Footer

DSL builder extension function.

form

fun Container.form(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, init: FormPanel<Map<String, Any?>>.() -> Unit? = null): FormPanel<Map<String, Any?>>

DSL builder extension function.

formPanel

inline fun <K : Any> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, customSerializers: Map<KClass<*>, KSerializer<*>>? = null, noinline init: FormPanel<K>.() -> Unit? = null): FormPanel<K>

DSL builder extension function.

genericRadioGroup

fun <T> Container.genericRadioGroup(options: List<Pair<T, String>>? = null, value: T? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false, toStr: (T) -> String = { it.toString() }, fromStr: (String) -> T? = { @Suppress("UNCHECKED_CAST") it as? T }, init: GenericRadioGroup<T>.() -> Unit? = null): GenericRadioGroup<T>

DSL builder extension function.

genericRadioGroupInput

fun <T> Container.genericRadioGroupInput(options: List<Pair<T, String>>? = null, value: T? = null, name: String? = null, inline: Boolean = false, toStr: (T) -> String = { it.toString() }, fromStr: (String) -> T? = { @Suppress("UNCHECKED_CAST") it as? T }, init: GenericRadioGroupInput<T>.() -> Unit? = null): GenericRadioGroupInput<T>

DSL builder extension function.

getAttribute

open override fun getAttribute(name: String): String?

Returns the value of an additional attribute.

getChildren

open override fun getChildren(): List<Component>

Returns a list of children of the current container.

getElement

open override fun getElement(): HTMLElement?

Returns DOM element bound to the current component.

getElementD

open override fun getElementD(): dynamic

Returns DOM element bound to the current component as a dynamic type.

getSnStyle

open fun getSnStyle(): dynamic

Returns CSS style attributes.

getStyle

fun getStyle(name: String): String?

Returns the value of a custom CSS style.

gridPanel

fun Container.gridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridAutoFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: JustifyItems? = null, alignItems: AlignItems? = null, justifyContent: JustifyContent? = null, alignContent: AlignContent? = null, useWrappers: Boolean = false, className: String? = null, init: GridPanel.() -> Unit? = null): GridPanel

DSL builder extension function.

fun Container.h1(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H1.() -> Unit? = null): H1

DSL builder extension function.

fun Container.h2(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H2.() -> Unit? = null): H2

DSL builder extension function.

fun Container.h3(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H3.() -> Unit? = null): H3

DSL builder extension function.

fun Container.h4(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H4.() -> Unit? = null): H4

DSL builder extension function.

fun Container.h5(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H5.() -> Unit? = null): H5

DSL builder extension function.

fun Container.h6(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H6.() -> Unit? = null): H6

DSL builder extension function.

hasCssClass

open override fun hasCssClass(css: String): Boolean

Checks whether the given value is present in the set of CSS classes.

header

fun Container.header(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Header.() -> Unit? = null): Header

DSL builder extension function.

hide

open fun hide()

Makes current widget invisible.

hPanel

fun Container.hPanel(wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: HPanel.() -> Unit? = null): HPanel

DSL builder extension function.

fun Container.i(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: I.() -> Unit? = null): I

DSL builder extension function.

icon

fun Container.icon(icon: String, init: Icon.() -> Unit? = null): Icon

DSL builder extension function.

iframe

fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, className: String? = null, init: Iframe.() -> Unit? = null): Iframe

DSL builder extension function.

image

fun Container.image(src: ResString?, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, className: String? = null, init: Image.() -> Unit? = null): Image

DSL builder extension function.

inheritingStyle

fun Widget.inheritingStyle(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, parentStyle: Style? = null, init: InheritingStyle.() -> Unit? = null): InheritingStyle

DSL builder extension function.

input

fun Container.input(type: InputType? = null, className: String? = null, init: Input.() -> Unit? = null): Input

DSL builder extension function.

invoke

open operator fun invoke(vararg children: Component)

Operator function for adding children in a DSL style.

label

fun Container.label(content: String? = null, rich: Boolean = false, forId: String? = null, className: String? = null, init: Label.() -> Unit? = null): Label

DSL builder extension function.

fun Container.li(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Li.() -> Unit? = null): Li

DSL builder extension function.

link

fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, separator: String? = null, labelFirst: Boolean = true, target: String? = null, dataNavigo: Boolean? = null, className: String? = null, init: Link.() -> Unit? = null): Link

DSL builder extension function.

listTag

fun Container.listTag(type: ListType, elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: ListTag.() -> Unit? = null): ListTag

DSL builder extension function.

main

fun Container.main(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Main.() -> Unit? = null): Main

DSL builder extension function.

nav

fun Container.nav(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Nav.() -> Unit? = null): Nav

DSL builder extension function.

numeric

fun Container.numeric(value: Number? = null, name: String? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), label: String? = null, rich: Boolean = false, init: Numeric.() -> Unit? = null): Numeric

DSL builder extension function.

numericInput

fun Container.numericInput(value: Number? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), className: String? = null, init: NumericInput.() -> Unit? = null): NumericInput

DSL builder extension function.

fun Container.ol(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ol.() -> Unit? = null): Ol

DSL builder extension function.

fun Container.p(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: P.() -> Unit? = null): P

DSL builder extension function.

password

fun Container.password(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Password.() -> Unit? = null): Password

DSL builder extension function.

radio

fun Container.radio(value: Boolean = false, extraValue: String? = null, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: Radio.() -> Unit? = null): Radio

DSL builder extension function.

radioGroup

fun Container.radioGroup(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false, init: RadioGroup.() -> Unit? = null): RadioGroup

DSL builder extension function.

radioGroupInput

fun Container.radioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, init: RadioGroupInput.() -> Unit? = null): RadioGroupInput

DSL builder extension function.

radioInput

fun Container.radioInput(value: Boolean = false, className: String? = null, init: RadioInput.() -> Unit? = null): RadioInput

DSL builder extension function.

range

fun Container.range(value: Number? = null, name: String? = null, min: Number = 0, max: Number = 100, step: Number = RANGE_DEFAULT_STEP, label: String? = null, rich: Boolean = false, init: Range.() -> Unit? = null): Range

DSL builder extension function.

rangeInput

fun Container.rangeInput(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = RANGE_DEFAULT_STEP, className: String? = null, init: RangeInput.() -> Unit? = null): RangeInput

DSL builder extension function.

remove

open override fun remove(child: Component)

Removes given component from the current container.

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

Remove the after create hook function (the same function reference must be used).

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

Remove the after destroy hook function (the same function reference must be used).

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

Remove the after insert hook function (the same function reference must be used).

removeAll

open override fun removeAll()

Removes all children from the current container.

removeAt

open override fun removeAt(position: Int)

Removes child component from the current container at the given position.

removeAttribute

open override fun removeAttribute(name: String)

Removes the value of additional attribute.

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

Remove the before dispose hook function (the same function reference must be used).

removeCssClass

open override fun removeCssClass(css: String)

Removes given value from the set of CSS classes generated in html code of current component.

removeCssStyle

open override fun removeCssStyle(css: Style)

Removes given style object from the set of CSS classes generated in html code of current component.

removeEventListener

open fun removeEventListener(id: Int)

Removes event listener from current widget.

removeEventListeners

open fun removeEventListeners()

Removes all event listeners from current widget.

removeStyle

fun removeStyle(name: String)

Removes the value of a custom CSS style.

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

Removes given value from the set of CSS classes generated in html code of parent component.

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

Removes given style object from the set of CSS classes generated in html code of parent component.

section

fun Container.section(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Section.() -> Unit? = null): Section

DSL builder extension function.

select

fun Container.select(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Select.() -> Unit? = null): Select

DSL builder extension function.

selectInput

fun Container.selectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, className: String? = null, init: SelectInput.() -> Unit? = null): SelectInput

DSL builder extension function.

setAttribute

open override fun setAttribute(name: String, value: String)

Sets the value of additional attribute.

setData

inline fun <K : Any> Template.setData(obj: K)

fun <K> Template.setData(obj: K, serializer: SerializationStrategy<K>)

Extension function to set serializable object as a template data.

setDragDropData

open fun setDragDropData(format: String, data: String)

Sets D&D data for the current widget. It also makes it draggable.

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit)

Sets the current widget as a D&D drop target.

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

Sets the current widget as a D&D drop target with helper callback accepting String data.

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

Sets an event listener for current widget, keeping the actual type of component.

setStyle

fun setStyle(name: String, value: String)

Sets the value of a custom CSS style.

show

open fun show()

Makes current widget visible.

simplePanel

fun Container.simplePanel(vararg styles: Style, init: SimplePanel.() -> Unit? = null): SimplePanel

DSL builder extension function with Style support

fun Container.simplePanel(className: String? = null, init: SimplePanel.() -> Unit? = null): SimplePanel

DSL builder extension function.

singleRender

open override fun <T> singleRender(block: () -> T): T

Executes given function within a single rendering process.

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

Executes given function within a single rendering process asynchronously.

small

fun Container.small(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Small.() -> Unit? = null): Small

DSL builder extension function.

span

fun Container.span(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Span.() -> Unit? = null): Span

DSL builder extension function.

spinner

fun Container.spinner(value: Number? = null, name: String? = null, min: Int? = null, max: Int? = null, step: Int = SPINNER_DEFAULT_STEP, label: String? = null, rich: Boolean = false, init: Spinner.() -> Unit? = null): Spinner

DSL builder extension function.

spinnerInput

fun Container.spinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Int = SPINNER_DEFAULT_STEP, className: String? = null, init: SpinnerInput.() -> Unit? = null): SpinnerInput

DSL builder extension function.

splitPanel

fun Container.splitPanel(direction: Direction = Direction.VERTICAL, className: String? = null, init: SplitPanel.() -> Unit? = null): SplitPanel

DSL builder extension function.

stackPanel

fun Container.stackPanel(activateLast: Boolean = true, className: String? = null, init: StackPanel.() -> Unit? = null): StackPanel

DSL builder extension function.

strong

fun Container.strong(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Strong.() -> Unit? = null): Strong

DSL builder extension function.

style

fun Widget.style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: Style.() -> Unit? = null): Style

DSL builder extension function.

table

fun Container.table(className: String? = null, init: Table.() -> Unit? = null): Table

DSL builder extension function.

tag

fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: Tag.() -> Unit? = null): Tag

DSL builder extension function.

text

fun Container.text(type: InputType = InputType.TEXT, value: String? = null, name: String? = null, maxlength: Int? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Text.() -> Unit? = null): Text

DSL builder extension function.

textArea

fun Container.textArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: TextArea.() -> Unit? = null): TextArea

DSL builder extension function.

textAreaInput

fun Container.textAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, className: String? = null, init: TextAreaInput.() -> Unit? = null): TextAreaInput

DSL builder extension function.

textInput

fun Container.textInput(type: InputType = InputType.TEXT, value: String? = null, maxlength: Int? = null, className: String? = null, init: TextInput.() -> Unit? = null): TextInput

DSL builder extension function.

textNode

fun Container.textNode(content: String, rich: Boolean = false, init: TextNode.() -> Unit? = null): TextNode

DSL builder extension function.

time

fun Container.time(datetime: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Time.() -> Unit? = null): Time

DSL builder extension function.

toggleVisible

open fun toggleVisible()

Toggles visibility of current widget.

fun Container.tr(className: String? = null, init: Tr.() -> Unit? = null): Tr

DSL builder extension function.

translate

open fun translate(text: String): String

open fun translate(text: String?): String?

Translates given text with I18n trans function and sets lastLanguage marker.

triStateCheckBox

fun Container.triStateCheckBox(value: Boolean? = null, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: TriStateCheckBox.() -> Unit? = null): TriStateCheckBox

DSL builder extension function.

triStateCheckBoxInput

fun Container.triStateCheckBoxInput(value: Boolean = false, className: String? = null, init: TriStateCheckBoxInput.() -> Unit? = null): TriStateCheckBoxInput

DSL builder extension function.

fun Container.ul(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ul.() -> Unit? = null): Ul

DSL builder extension function.

unaryPlus

open operator override fun String.unaryPlus()

An operator to add a text node to the container.

upload

fun Container.upload(multiple: Boolean = false, accept: List<String>? = null, capture: Capture? = null, label: String? = null, rich: Boolean = false, init: Upload.() -> Unit? = null): Upload

DSL builder extension function.

uploadInput

fun Container.uploadInput(multiple: Boolean = false, accept: List<String>? = null, capture: Capture? = null, className: String? = null, init: UploadInput.() -> Unit? = null): UploadInput

DSL builder extension function.

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()

Makes the component use distinct snabbdom key.

vPanel

fun Container.vPanel(justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: VPanel.() -> Unit? = null): VPanel

DSL builder extension function.

widget

fun Container.widget(className: String? = null, init: Widget.() -> Unit? = null): Widget

DSL builder extension function.