kvision/io.kvision.core/Container

Container

interface Container : Component

Base interface for all containers.

Inheritors

SimplePanel

Properties

parent

abstract var parent: Container?

Parent of the current component.

visible

abstract var visible: Boolean

Visibility state of the current component.

Functions

actionSheet

fun Container.actionSheet(actionSheetTitle: String? = null, cancelable: Boolean? = null, animation: Boolean? = null, className: String? = null, init: ActionSheet.() -> Unit? = null): ActionSheet

DSL builder extension function.

add

abstract fun add(child: Component)

Adds given component to the current container.

abstract fun add(position: Int, child: Component)

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

addAfterCreateHook

abstract fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

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

addAfterDestroyHook

abstract fun addAfterDestroyHook(hook: () -> Unit): Boolean

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

addAfterInsertHook

abstract fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

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

addAll

abstract fun addAll(children: List<Component>)

Adds a list of components to the current container.

addBeforeDisposeHook

abstract fun addBeforeDisposeHook(hook: () -> Unit): Boolean

The supplied function is called before the component is disposed.

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor)

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder)

addBsClearfix

fun Component.addBsClearfix()

addBsColor

fun Component.addBsColor(bsColor: BsColor)

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded)

addCssClass

abstract fun addCssClass(css: String)

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

addCssStyle

abstract 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

abstract fun addSurroundingCssClass(css: String)

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

addSurroundingCssStyle

abstract fun addSurroundingCssStyle(css: Style)

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

alertDialog

fun Container.alertDialog(dialogTitle: String? = null, cancelable: Boolean? = null, animation: Boolean? = null, rowfooter: Boolean? = null, className: String? = null, init: AlertDialog.() -> Unit? = null): AlertDialog

DSL builder extension function.

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.

badge

fun Container.badge(content: String? = null, bsColor: BsColor = BsColor.SECONDARYBG, rounded: Boolean = false, position: BadgePosition? = null, init: Badge.() -> Unit = {}): <Error class: unknown class>

DSL builder extension function.

blur

open fun blur()

Makes the element blur.

bootstrapUpload

fun Container.bootstrapUpload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false, init: BootstrapUpload.() -> Unit? = null): BootstrapUpload

DSL builder extension function.

bootstrapUploadInput

fun Container.bootstrapUploadInput(uploadUrl: String? = null, multiple: Boolean = false, className: String? = null, init: BootstrapUploadInput.() -> Unit? = null): BootstrapUploadInput

DSL builder extension function.

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.

buttonGroup

fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, className: String? = null, init: ButtonGroup.() -> Unit? = null): ButtonGroup

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.

card

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

DSL builder extension function.

carousel

fun Container.carousel(direction: CarouselDirection? = null, fullscreen: Boolean? = null, overscrollable: Boolean? = null, autoScroll: Boolean? = null, animation: Boolean? = null, swipeable: Boolean? = null, initialIndex: Int? = null, className: String? = null, init: Carousel.() -> Unit? = null): Carousel

DSL builder extension function.

chart

fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, className: String? = null, init: Chart.() -> Unit? = null): Chart

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

abstract fun clearAfterCreateHooks()

Remove all after create hooks functions.

clearAfterDestroyHooks

abstract fun clearAfterDestroyHooks()

Remove all after destroy hooks functions.

clearAfterInsertHooks

abstract fun clearAfterInsertHooks()

Remove all after insert hooks functions.

clearBeforeDisposeHooks

abstract fun clearBeforeDisposeHooks()

Remove all before dispose hooks functions.

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.

collapse

fun Container.collapse(id: String, groupId: String? = null, horizontal: Boolean = false, opened: Boolean = false, init: Collapse.() -> Unit): <Error class: unknown class>

DSL builder extension function. It takes the same parameters as the constructor of the built component.

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.

dateTime

fun Container.dateTime(value: <Error class: unknown class>? = null, name: String? = null, format: String = "YYYY-MM-DD HH:mm", label: String? = null, rich: Boolean = false, init: DateTime.() -> Unit? = null): DateTime

DSL builder extension function.

dateTimeInput

fun Container.dateTimeInput(value: <Error class: unknown class>? = null, format: String = "YYYY-MM-DD HH:mm", className: String? = null, init: DateTimeInput.() -> Unit? = null): DateTimeInput

DSL builder extension function.

dialog

fun Container.dialog(cancelable: Boolean? = null, animation: Boolean? = null, className: String? = null, init: Dialog.() -> Unit? = null): Dialog

DSL builder extension function.

disposeAll

abstract 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.

dropDown

fun Container.dropDown(text: String, elements: List<<Error class: unknown class><String, String>>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, dark: Boolean = false, rightAligned: Boolean = false, autoClose: AutoClose = AutoClose.TRUE, arrowVisible: Boolean = true, className: String? = null, init: DropDown.() -> Unit? = null): DropDown

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.

fab

fun Container.fab(icon: String? = null, floatPosition: FloatPosition? = null, content: String? = null, rich: Boolean = false, className: String? = null, init: Fab.() -> Unit? = null): Fab

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 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<*>, <Error class: unknown class><out <Error class: unknown class>>>? = null, noinline init: FormPanel<K>.() -> Unit? = null): FormPanel<K>

DSL builder extension function.

genericRadioGroup

fun <T> Container.genericRadioGroup(options: List<<Error class: unknown class><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<<Error class: unknown class><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

abstract fun getAttribute(name: String): String?

Returns the value of an additional attribute.

getChildren

abstract fun getChildren(): List<Component>

Returns a list of children of the current container.

getElement

abstract fun getElement(): <Error class: unknown class>?

Returns DOM element bound to the current component.

getElementD

abstract fun getElementD(): dynamic

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

getElementJQuery

fun Component.getElementJQuery(): <Error class: unknown class>?

Returns JQuery element bound to the current component.

getElementJQueryD

fun Component.getElementJQueryD(): dynamic

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

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

abstract 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.

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

fun Container.icon(icon: String, size: String? = null, rotate: Number? = null, fixedWidth: Boolean? = null, spin: Boolean? = null, className: String? = null, 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.

imaskNumeric

fun Container.imaskNumeric(value: Number? = null, name: String? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), thousandsSeparator: Char? = I18n.detectThousandsSeparator(), padFractionalZeros: Boolean = false, normalizeZeros: Boolean = true, label: String? = null, rich: Boolean = false, init: ImaskNumeric.() -> Unit? = null): ImaskNumeric

DSL builder extension function.

imaskNumericInput

fun Container.imaskNumericInput(value: Number? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), thousandsSeparator: Char? = I18n.detectThousandsSeparator(), padFractionalZeros: Boolean = false, normalizeZeros: Boolean = true, className: String? = null, init: ImaskNumericInput.() -> Unit? = null): ImaskNumericInput

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.

maps

fun Container.maps(optionsConfigure: dynamic.() -> Unit? = null, className: String? = null, init: Maps.() -> Unit? = null): Maps

DSL builder extension function.

modal

fun Container.modal(animation: ModalAnimation? = null, className: String? = null, init: Modal.() -> Unit? = null): Modal

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.

navbar

fun Container.navbar(label: String? = null, link: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor? = null, bgColor: BsBgColor = BsBgColor.BODYTERTIARY, collapseOnClick: Boolean = false, dataNavigo: Boolean? = null, containerType: ContainerType = ContainerType.FLUID, className: String? = null, init: Navbar.() -> Unit? = null): Navbar

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.

offcanvas

fun Container.offcanvas(caption: String? = null, placement: OffPlacement = OffPlacement.START, closeButton: Boolean = true, dark: Boolean = false, responsiveType: OffResponsiveType? = null, scrollableBody: Boolean = false, backdrop: Boolean = true, escape: Boolean = true, className: String? = null, init: Offcanvas.() -> Unit? = null): Offcanvas

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.

onsButton

fun Container.onsButton(content: String? = null, rich: Boolean = false, align: Align? = null, icon: String? = null, buttonType: OnsButtonType? = null, large: Boolean? = null, ripple: Boolean? = null, disabled: Boolean? = null, className: String? = null, init: OnsButton.() -> Unit? = null): OnsButton

DSL builder extension function.

onsCheckBox

fun Container.onsCheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsCheckBox.() -> Unit? = null): OnsCheckBox

DSL builder extension function.

onsCheckBoxInput

fun Container.onsCheckBoxInput(value: Boolean = false, inputId: String? = null, className: String? = null, init: OnsCheckBoxInput.() -> Unit? = null): OnsCheckBoxInput

DSL builder extension function.

onsDateTime

fun Container.onsDateTime(value: <Error class: unknown class>? = null, mode: DateTimeMode = DateTimeMode.DATETIME, min: <Error class: unknown class>? = null, max: <Error class: unknown class>? = null, step: Number? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsDateTime.() -> Unit? = null): OnsDateTime

DSL builder extension function.

onsDateTimeInput

fun Container.onsDateTimeInput(value: <Error class: unknown class>? = null, mode: DateTimeMode = DateTimeMode.DATETIME, min: <Error class: unknown class>? = null, max: <Error class: unknown class>? = null, step: Number? = null, inputId: String? = null, className: String? = null, init: OnsDateTimeInput.() -> Unit? = null): OnsDateTimeInput

DSL builder extension function.

onsList

fun Container.onsList(inset: Boolean = false, noborder: Boolean = false, className: String? = null, init: OnsList.() -> Unit? = null): OnsList

DSL builder extension function.

onsListTitle

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

DSL builder extension function.

onsNumber

fun Container.onsNumber(value: Number? = null, min: Number? = null, max: Number? = null, step: Number = DEFAULT_STEP, placeholder: String? = null, floatLabel: Boolean? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsNumber.() -> Unit? = null): OnsNumber

DSL builder extension function.

onsNumberInput

fun Container.onsNumberInput(value: Number? = null, min: Number? = null, max: Number? = null, step: Number = DEFAULT_STEP, placeholder: String? = null, floatLabel: Boolean? = null, inputId: String? = null, className: String? = null, init: OnsNumberInput.() -> Unit? = null): OnsNumberInput

DSL builder extension function.

onsRadio

fun Container.onsRadio(value: Boolean = false, extraValue: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsRadio.() -> Unit? = null): OnsRadio

DSL builder extension function.

onsRadioGroup

fun Container.onsRadioGroup(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsRadioGroup.() -> Unit? = null): OnsRadioGroup

DSL builder extension function.

onsRadioGroupInput

fun Container.onsRadioGroupInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, name: String? = null, className: String? = null, init: OnsRadioGroupInput.() -> Unit? = null): OnsRadioGroupInput

DSL builder extension function.

onsRadioInput

fun Container.onsRadioInput(value: Boolean = false, inputId: String? = null, className: String? = null, init: OnsRadioInput.() -> Unit? = null): OnsRadioInput

DSL builder extension function.

onsRange

fun Container.onsRange(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsRange.() -> Unit? = null): OnsRange

DSL builder extension function.

onsRangeInput

fun Container.onsRangeInput(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, inputId: String? = null, className: String? = null, init: OnsRangeInput.() -> Unit? = null): OnsRangeInput

DSL builder extension function.

onsSelect

fun Container.onsSelect(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsSelect.() -> Unit? = null): OnsSelect

DSL builder extension function.

onsSelectInput

fun Container.onsSelectInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, inputId: String? = null, className: String? = null, init: OnsSelectInput.() -> Unit? = null): OnsSelectInput

DSL builder extension function.

onsSwitch

fun Container.onsSwitch(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsSwitch.() -> Unit? = null): OnsSwitch

DSL builder extension function.

onsSwitchInput

fun Container.onsSwitchInput(value: Boolean = false, inputId: String? = null, className: String? = null, init: OnsSwitchInput.() -> Unit? = null): OnsSwitchInput

DSL builder extension function.

onsText

fun Container.onsText(type: InputType = InputType.TEXT, value: String? = null, placeholder: String? = null, floatLabel: Boolean? = null, name: String? = null, maxlength: Int? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsText.() -> Unit? = null): OnsText

DSL builder extension function.

onsTextInput

fun Container.onsTextInput(type: InputType = InputType.TEXT, value: String? = null, placeholder: String? = null, floatLabel: Boolean? = null, inputId: String? = null, maxlength: Int? = null, className: String? = null, init: OnsTextInput.() -> Unit? = null): OnsTextInput

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.

popover

fun Container.popover(direction: FloatDirection? = null, cancelable: Boolean? = null, animation: Boolean? = null, className: String? = null, init: Popover.() -> Unit? = null): Popover

DSL builder extension function.

progress

fun <T> Container.progress(bounds: Bounds<T>, className: String? = null, init: Progress<T>.() -> Unit? = null): Progress<T>

fun Container.progress(min: Number = 0, max: Number = 100, className: String? = null, init: Progress<Number>.() -> Unit? = null): Progress<Number>

DSL builder extension function.

progressBar

fun Container.progressBar(value: Number? = null, secondaryValue: Number? = null, indeterminate: Boolean? = null, className: String? = null, init: ProgressBar.() -> Unit? = null): ProgressBar

DSL builder extension function.

progressCircular

fun Container.progressCircular(value: Number? = null, secondaryValue: Number? = null, indeterminate: Boolean? = null, className: String? = null, init: ProgressCircular.() -> Unit? = null): ProgressCircular

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<<Error class: unknown class><String, String>>? = 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<<Error class: unknown class><String, String>>? = 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.

react

fun Container.react(className: String? = null, builder: <Error class: unknown class>.() -> Unit): React<dynamic>

fun <S> Container.react(state: S, className: String? = null, builder: <Error class: unknown class>.(getState: () -> S, changeState: ((S) -> S) -> Unit) -> Unit): React<S>

DSL builder extension function.

reactBind

fun <S> Container.reactBind(state: ObservableState<S>, className: String? = null, builder: <Error class: unknown class>.(getState: () -> S, changeState: ((S) -> S) -> Unit) -> Unit): React<S>

DSL builder extension function for binding to ObservableState

remove

abstract fun remove(child: Component)

Removes given component from the current container.

removeAfterCreateHook

abstract fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

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

removeAfterDestroyHook

abstract fun removeAfterDestroyHook(hook: () -> Unit): Boolean

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

removeAfterInsertHook

abstract fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

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

removeAll

abstract fun removeAll()

Removes all children from the current container.

removeAt

abstract fun removeAt(position: Int)

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

removeAttribute

abstract fun removeAttribute(name: String)

Removes the value of additional attribute.

removeBeforeDisposeHook

abstract fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

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

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor)

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder)

removeBsClearfix

fun Component.removeBsClearfix()

removeBsColor

fun Component.removeBsColor(bsColor: BsColor)

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded)

removeCssClass

abstract fun removeCssClass(css: String)

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

removeCssStyle

abstract fun removeCssStyle(css: Style)

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

removeSurroundingCssClass

abstract fun removeSurroundingCssClass(css: String)

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

removeSurroundingCssStyle

abstract fun removeSurroundingCssStyle(css: Style)

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

responsiveGridPanel

fun Container.responsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, className: String? = null, init: ResponsiveGridPanel.() -> Unit? = null): ResponsiveGridPanel

DSL builder extension function.

richText

fun Container.richText(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, allowFileUploads: Boolean = false, init: RichText.() -> Unit? = null): RichText

DSL builder extension function.

richTextInput

fun Container.richTextInput(value: String? = null, allowFileUploads: Boolean = false, className: String? = null, init: RichTextInput.() -> Unit? = null): RichTextInput

DSL builder extension function.

ripple

fun Container.ripple(rippleColor: Color? = null, rippleBackground: Color? = null, size: RippleSize? = null, center: Boolean? = null, className: String? = null, init: Ripple.() -> Unit? = null): Ripple

DSL builder extension function.

row

fun Container.row(rowVerticalAlign: GridVerticalAlign? = null, className: String? = null, init: Row.() -> Unit? = null): Row

DSL builder extension function.

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.

segment

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

DSL builder extension function.

select

fun Container.select(options: List<<Error class: unknown class><String, String>>? = 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<<Error class: unknown class><String, String>>? = 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.

selectRemote

fun <T : Any> Container.selectRemote(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, name: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, label: String? = null, rich: Boolean = false, init: SelectRemote<T>.() -> Unit? = null): SelectRemote<T>

DSL builder extension function.

selectRemoteInput

fun <T : Any> Container.selectRemoteInput(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: SelectRemoteInput<T>.() -> Unit? = null): SelectRemoteInput<T>

DSL builder extension function.

setAttribute

abstract fun setAttribute(name: String, value: String)

Sets the value of additional attribute.

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

abstract fun <T> singleRender(block: () -> T): T

Executes given function within a single rendering process.

singleRenderAsync

abstract 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.

speedDial

fun Container.speedDial(icon: String? = null, floatPosition: FloatPosition? = null, floatDirection: FloatDirection? = null, content: String? = null, rich: Boolean = false, className: String? = null, init: SpeedDial.() -> Unit? = null): SpeedDial

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.

switch

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

DSL builder extension function.

switchInput

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

DSL builder extension function.

table

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

fun Container.table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsiveType: ResponsiveType? = null, tableColor: TableColor? = null, theadColor: TableColor? = null, tbodyDivider: Boolean = false, className: String? = null, init: Table.() -> Unit? = null): Table

DSL builder extension function.

tabPanel

fun Container.tabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, draggableTabs: Boolean = false, className: String? = null, init: TabPanel.() -> Unit? = null): TabPanel

DSL builder extension function.

tabulator

fun Container.tabulator(options: TabulatorOptions<dynamic> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, init: Tabulator<dynamic>.() -> Unit? = null): Tabulator<dynamic>

DSL builder extension function for dynamic data (send within options parameter).

inline fun <T : Any, S : Any> Container.tabulator(store: ObservableState<S>, noinline dataFactory: (S) -> List<T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, serializer: <Error class: unknown class><T> = serializer(), serializersModule: <Error class: unknown class>? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>

DSL builder extension function for a general observable store.

inline fun <T : Any> Container.tabulator(data: List<T>? = null, dataUpdateOnEdit: Boolean = true, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, serializer: <Error class: unknown class><T> = serializer(), serializersModule: <Error class: unknown class>? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>

DSL builder extension function.

tabulatorPagination

fun <T : Any> Container.tabulatorPagination(className: String? = null, init: TabulatorPagination<T>.() -> Unit? = null): TabulatorPagination<T>

DSL builder extension function.

tabulatorRemote

inline fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: <Error class: unknown class><E>, noinline function: suspend E.(Int?, Int?, List<<Error class: unknown class>>?, List<<Error class: unknown class>>?, String?) -> <Error class: unknown class><T>, noinline stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, serializer: <Error class: unknown class><T>? = null, module: <Error class: unknown class>? = null, noinline requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, noinline init: TabulatorRemote<T, E>.() -> Unit? = null): TabulatorRemote<T, E>

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.

themeSwitcher

fun Container.themeSwitcher(title: String? = "Switch color theme", style: ButtonStyle = ButtonStyle.SECONDARY, round: Boolean = false, disabled: Boolean = false, className: String? = null, init: ThemeSwitcher.() -> Unit? = null): ThemeSwitcher

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.

toast

fun Container.toast(animation: ToastAnimation? = null, className: String? = null, init: Toast.() -> Unit? = null): Toast

DSL builder extension function.

tomSelect

fun Container.tomSelect(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, label: String? = null, rich: Boolean = false, init: TomSelect.() -> Unit? = null): TomSelect

DSL builder extension function.

tomSelectInput

fun Container.tomSelectInput(options: List<<Error class: unknown class><String, String>>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, className: String? = null, init: TomSelectInput.() -> Unit? = null): TomSelectInput

DSL builder extension function.

tomSelectRemote

fun <T : Any> Container.tomSelectRemote(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, openOnFocus: Boolean = false, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomSelectRemote<T>.() -> Unit? = null): TomSelectRemote<T>

DSL builder extension function.

tomSelectRemoteInput

fun <T : Any> Container.tomSelectRemoteInput(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?, String?) -> List<<Error class: unknown class>>, stateFunction: () -> String? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, maxOptions: Int? = null, tsOptions: TomSelectOptions? = null, tsCallbacks: TomSelectCallbacks? = null, tsRenders: TomSelectRenders? = null, preload: Boolean = false, openOnFocus: Boolean = false, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: TomSelectRemoteInput<T>.() -> Unit? = null): TomSelectRemoteInput<T>

DSL builder extension function.

tomTypeahead

fun Container.tomTypeahead(options: List<String>? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeahead.() -> Unit? = null): TomTypeahead

DSL builder extension function.

tomTypeaheadInput

fun Container.tomTypeaheadInput(options: List<String>? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, className: String? = null, init: TomTypeaheadInput.() -> Unit? = null): TomTypeaheadInput

DSL builder extension function.

tomTypeaheadRemote

fun <T : Any> Container.tomTypeaheadRemote(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeaheadRemote<T>.() -> Unit? = null): TomTypeaheadRemote<T>

DSL builder extension function.

tomTypeaheadRemoteInput

fun <T : Any> Container.tomTypeaheadRemoteInput(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: TomTypeaheadRemoteInput<T>.() -> Unit? = null): TomTypeaheadRemoteInput<T>

DSL builder extension function.

toolbar

fun Container.toolbar(size: ButtonGroupSize? = null, spacing: Int = 2, vertical: Boolean = false, className: String? = null, init: Toolbar.() -> Unit? = null): Toolbar

DSL builder extension function.

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

DSL builder extension function.

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 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.

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.

window

fun Container.window(caption: String? = null, contentWidth: <Error class: unknown class><Number, UNIT>? = CssSize(0, UNIT.auto), contentHeight: <Error class: unknown class><Number, UNIT>? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, maximizeButton: Boolean = false, minimizeButton: Boolean = false, icon: String? = null, className: String? = null, init: Window.() -> Unit? = null): Window

DSL builder extension function.