kvision/io.kvision.onsenui.form/OnsNumber

OnsNumber

open class 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) : SimplePanel, NumberFormControl, MutableState<Number?>

Onsen UI form field number component.

Parameters

value

number input value

min

minimal value

max

maximal value

step

step value (default 1)

placeholder

the placeholder for the number input

floatLabel

whether the placeholder will be animated in Material Design

name

the name attribute of the generated HTML input element

label

label text bound to the input element

rich

determines if label can contain HTML code

className

CSS class names

init

an initializer extension function

Constructors

OnsNumber

constructor(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)

Creates a form field number component.

Types

Companion

object Companion

Properties

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.

autocomplete

var autocomplete: Autocomplete?

Determines if autocomplete is enabled for the input element.

autofocus

var autofocus: Boolean?

Determines if the number input is automatically focused.

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: <Error class: unknown class><Number, UNIT>?

CSS border radius.

borderRadiusList

open var borderRadiusList: List<<Error class: unknown class><Number, UNIT>>?

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: <Error class: unknown class><Number, UNIT>?

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

cursor

open var cursor: Cursor?

CSS cursor shape over the current component.

disabled

open var disabled: Boolean

Determines if the field is disabled.

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?

flabel

override val flabel: FieldLabel

Form field label.

flexBasis

open var flexBasis: <Error class: unknown class><Number, UNIT>?

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.

floatLabel

var floatLabel: Boolean?

Whether the placeholder will be animated in Material Design.

fontFamily

open var fontFamily: String?

CSS font family of the current component.

fontSize

open var fontSize: <Error class: unknown class><Number, UNIT>?

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: <Error class: unknown class><Number, UNIT>?

Height of the current component.

var id: String?

An ID attribute of generated HTML element.

input

override val input: OnsNumberInput

The actual input component.

invalidFeedback

override val invalidFeedback: InvalidFeedback

Invalid feedback component.

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

label

var label: String?

The label text bound to the number input element.

left

open var left: <Error class: unknown class><Number, UNIT>?

Left edge of the current component.

letterSpacing

open var letterSpacing: <Error class: unknown class><Number, UNIT>?

CSS Text letter spacing of the current component.

lineBreak

open var lineBreak: LineBreak?

CSS line break of the current component.

lineHeight

open var lineHeight: <Error class: unknown class><Number, UNIT>?

CSS Text line height of the current component.

listStyle

open var listStyle: ListStyle?

List style of the current component.

margin

open var margin: <Error class: unknown class><Number, UNIT>?

Margin of the current component.

marginBottom

open var marginBottom: <Error class: unknown class><Number, UNIT>?

Bottom margin of the current component.

marginLeft

open var marginLeft: <Error class: unknown class><Number, UNIT>?

Left margin of the current component.

marginRight

open var marginRight: <Error class: unknown class><Number, UNIT>?

Right margin of the current component.

marginTop

open var marginTop: <Error class: unknown class><Number, UNIT>?

Top margin of the current component.

max

var max: Number?

Maximal value.

maxHeight

open var maxHeight: <Error class: unknown class><Number, UNIT>?

Maximal height of the current component.

maxWidth

open var maxWidth: <Error class: unknown class><Number, UNIT>?

Maximal width of the current component.

min

var min: Number?

Minimal value.

minHeight

open var minHeight: <Error class: unknown class><Number, UNIT>?

Minimal height of the current component.

minWidth

open var minWidth: <Error class: unknown class><Number, UNIT>?

Minimal width of the current component.

modifier

var modifier: String?

A modifier attribute to specify custom styles.

mutableStateFlow

val <S> MutableState<S>.mutableStateFlow: <Error class: unknown class><S>

Extension property returning a MutableStateFlow ~~for a MutableState.~~

name

Link copied to clipboard

open var name: String?
The name attribute of the generated HTML input element.

opacity

Link copied to clipboard

open var opacity: Double?
Opacity of the current component.

order

Link copied to clipboard

open var order: Int?
CSS flexbox item order.

outline

Link copied to clipboard

open var outline: Outline?
Outline of the current component.

overflow

Link copied to clipboard

open var overflow: Overflow?
CSS overflow of the current component.

overflowWrap

Link copied to clipboard

open var overflowWrap: OverflowWrap?
CSS overflow-wrap of the current component.

overflowX

Link copied to clipboard

open var overflowX: Overflow?
CSS overflow-x of the current component.

overflowY

Link copied to clipboard

open var overflowY: Overflow?
CSS overflow-y of the current component.

padding

Link copied to clipboard

open var padding: <Error class: unknown class><Number, UNIT>?
Padding of the current component.

paddingBottom

Link copied to clipboard

open var paddingBottom: <Error class: unknown class><Number, UNIT>?
Bottom padding of the current component.

paddingLeft

Link copied to clipboard

open var paddingLeft: <Error class: unknown class><Number, UNIT>?
Left padding of the current component.

paddingRight

Link copied to clipboard

open var paddingRight: <Error class: unknown class><Number, UNIT>?
Right padding of the current component.

paddingTop

Link copied to clipboard

open var paddingTop: <Error class: unknown class><Number, UNIT>?
Top padding of the current component.

parent

Link copied to clipboard

open override var parent: Container?
Parent of the current component.

placeholder

Link copied to clipboard

var placeholder: String?
The placeholder for the number input.

popoverHooksActive

Link copied to clipboard

var popoverHooksActive: Boolean

popoverOptions

Link copied to clipboard

var popoverOptions: dynamic

position

Link copied to clipboard

open var position: Position?
CSS position of the current component.

readonly

Link copied to clipboard

var readonly: Boolean?
Determines if the number input is read-only.

resize

Link copied to clipboard

open var resize: Resize?
CSS resize of the current component.

rich

Link copied to clipboard

var rich: Boolean
Determines if label can contain HTML code.

right

Link copied to clipboard

open var right: <Error class: unknown class><Number, UNIT>?
Right edge of the current component.

role

Link copied to clipboard

var role: String?
A role attribute of generated HTML element.

size

Link copied to clipboard

open var size: InputSize?
Input control field size.

startValue

Link copied to clipboard

var startValue: Number?
The value attribute of the generated HTML input element.

stateFlow

Link copied to clipboard

val <S> ObservableState<S>.stateFlow: <Error class: unknown class><S>
Extension property returning a StateFlow ~~for an ObservableState.~~

step

Link copied to clipboard

var step: Number
Step value.

tabindex

Link copied to clipboard

var tabindex: Int?
A tabindex attribute of generated HTML element.

textAlign

Link copied to clipboard

open var textAlign: TextAlign?
CSS Text align of the current component.

textDecoration

Link copied to clipboard

open var textDecoration: TextDecoration?
CSS Text decoration of the current component.

textDirection

Link copied to clipboard

open var textDirection: Direction?
CSS Text direction of the current component.

textIndent

Link copied to clipboard

open var textIndent: <Error class: unknown class><Number, UNIT>?
CSS Text indent of the current component.

textOverflow

Link copied to clipboard

open var textOverflow: TextOverflow?
CSS Text overflow of the current component.

textShadow

Link copied to clipboard

open var textShadow: TextShadow?
CSS Text shadow of the current component.

textTransform

Link copied to clipboard

open var textTransform: TextTransform?
CSS Text transform of the current component.

title

Link copied to clipboard

var title: String?
A title attribute of generated HTML element.

tooltipHooksActive

Link copied to clipboard

var tooltipHooksActive: Boolean

tooltipOptions

Link copied to clipboard

var tooltipOptions: dynamic

top

Link copied to clipboard

open var top: <Error class: unknown class><Number, UNIT>?
Top edge of the current component.

transition

Link copied to clipboard

open var transition: Transition?
CSS transition effect for the current component.

transitionList

Link copied to clipboard

open var transitionList: List<Transition>?
List of CSS transition effects for the current component.

unicodeBidi

Link copied to clipboard

open var unicodeBidi: UnicodeBidi?
CSS Text unicode-bidi of the current component.

validationStatus

Link copied to clipboard

open var validationStatus: ValidationStatus?
Input control validation status.

validatorError

Link copied to clipboard

open var validatorError: String?
Validator error message.

value

Link copied to clipboard

open override var value: Number?
Number input value.

verticalAlign

Link copied to clipboard

open var verticalAlign: VerticalAlign?
CSS Text vertical align of the current component.

visible

Link copied to clipboard

open override var visible: Boolean
Visibility state of the current component.

whiteSpace

Link copied to clipboard

open var whiteSpace: WhiteSpace?
CSS Text white space of the current component.

width

Link copied to clipboard

open var width: <Error class: unknown class><Number, UNIT>?
Width of the current component.

wordBreak

Link copied to clipboard

open var wordBreak: WordBreak?
CSS word break of the current component.

wordSpacing

Link copied to clipboard

open var wordSpacing: <Error class: unknown class><Number, UNIT>?
CSS Text word spacing of the current component.

zIndex

Link copied to clipboard

open var zIndex: Int?
Z-index of the current component.

Functions

actionSheet

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open override fun addAfterCreateHook(hook: (VNode) -> Unit): <Error class: unknown class>
The supplied function is called after the widget DOM element is created.

addAfterDestroyHook

Link copied to clipboard

open override fun addAfterDestroyHook(hook: () -> Unit): <Error class: unknown class>
The supplied function is called after the widget is removed from the DOM.

addAfterInsertHook

Link copied to clipboard

open override fun addAfterInsertHook(hook: (VNode) -> Unit): <Error class: unknown class>
The supplied function is called after the widget is inserted into the DOM.

addAll

Link copied to clipboard

open override fun addAll(children: List<Component>)
Adds a list of components to the current container.

addBeforeDisposeHook

Link copied to clipboard

open override fun addBeforeDisposeHook(hook: () -> Unit): <Error class: unknown class>
The supplied function is called before the widget is disposed.

addBsBgColor

Link copied to clipboard

fun Component.addBsBgColor(bsBgColor: BsBgColor)

addBsBorder

Link copied to clipboard

fun Component.addBsBorder(vararg bsBorder: BsBorder)

addBsClearfix

Link copied to clipboard

fun Component.addBsClearfix()

addBsColor

Link copied to clipboard

fun Component.addBsColor(bsColor: BsColor)

addBsRounded

Link copied to clipboard

fun Component.addBsRounded(vararg bsRounded: BsRounded)

addCssClass

Link copied to clipboard

open override fun addCssClass(css: String)
Adds given value to the set of CSS classes generated in html code of current component.

addCssStyle

Link copied to clipboard

open override fun addCssStyle(css: Style)
Adds given style object to the set of CSS classes generated in html code of current component.

address

Link copied to clipboard

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

Link copied to clipboard

open override fun addSurroundingCssClass(css: String)
Adds given value to the set of CSS classes generated in html code of parent component.

addSurroundingCssStyle

Link copied to clipboard

open override fun addSurroundingCssStyle(css: Style)
Adds given style object to the set of CSS classes generated in html code of parent component.

alertDialog

Link copied to clipboard

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.

animate

Link copied to clipboard

fun Widget.animate(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null, styles: StyledComponent.() -> Unit)
Animate the widget changing CSS properties.

article

Link copied to clipboard

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

b

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open override fun blur()
Makes the element blur.

bootstrapUpload

Link copied to clipboard

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

Link copied to clipboard

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

br

Link copied to clipboard

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

button

Link copied to clipboard

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

Link copied to clipboard

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

canvas

Link copied to clipboard

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

card

Link copied to clipboard

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

carousel

Link copied to clipboard

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

Link copied to clipboard

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

checkBox

Link copied to clipboard

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

Link copied to clipboard

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

clearAfterCreateHooks

Link copied to clipboard

open override fun clearAfterCreateHooks()
Remove all after create hooks functions.

clearAfterDestroyHooks

Link copied to clipboard

open override fun clearAfterDestroyHooks()
Remove all after destroy hooks functions.

clearAfterInsertHooks

Link copied to clipboard

open override fun clearAfterInsertHooks()
Remove all after insert hooks functions.

clearBeforeDisposeHooks

Link copied to clipboard

open override fun clearBeforeDisposeHooks()
Remove all before dispose hooks functions.

clearDragDropData

Link copied to clipboard

open fun clearDragDropData()
Clears D&D data for the current widget. It also makes it not draggable.

code

Link copied to clipboard

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

Link copied to clipboard

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.

contextMenu

Link copied to clipboard

fun Widget.contextMenu(fixedPosition: Boolean = false, className: String? = null, init: ContextMenu.() -> Unit? = null): ContextMenu
DSL builder extension function.

customTag

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

disablePopover

Link copied to clipboard

fun Widget.disablePopover()
Disables popover for the current widget.

disableTooltip

Link copied to clipboard

fun Widget.disableTooltip()
Disables tooltip for the current widget.

dispatchEvent

Link copied to clipboard

open fun dispatchEvent(type: String, eventInitDict: <Error class: unknown class>): Boolean?
Dispatches a custom event.

disposeAll

Link copied to clipboard

open override fun disposeAll()
Removes all children from the current container and disposes them.

div

Link copied to clipboard

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

Link copied to clipboard

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

dropDown

Link copied to clipboard

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.

em

Link copied to clipboard

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

enableGestureDetector

Link copied to clipboard

fun Widget.enableGestureDetector()
Enable gesture detector for a given Widget.

enablePopover

Link copied to clipboard

fun Widget.enablePopover(options: PopoverOptions = PopoverOptions())
Enables popover for the current widget.

enableTooltip

Link copied to clipboard

fun Widget.enableTooltip(options: TooltipOptions = TooltipOptions())
Enables tooltip for the current widget.

fab

Link copied to clipboard

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.

fadeIn

Link copied to clipboard

fun Widget.fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)
Shows current widget with fade in effect.

fadeOut

Link copied to clipboard

fun Widget.fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)
Hides current widget with fade out effect.

fieldLabel

Link copied to clipboard

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

fieldset

Link copied to clipboard

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

Link copied to clipboard

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

figcaption

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open override fun focus()
Makes the element focused.

footer

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open override fun getAttribute(name: String): String?
Returns the value of an additional attribute.

getChildren

Link copied to clipboard

open override fun getChildren(): List<Component>
Returns a list of children of the current container.

getElement

Link copied to clipboard

open override fun getElement(): <Error class: unknown class>?
Returns DOM element bound to the current component.

getElementD

Link copied to clipboard

open override fun getElementD(): dynamic
Returns DOM element bound to the current component as a dynamic type.

getElementJQuery

Link copied to clipboard

fun Component.getElementJQuery(): <Error class: unknown class>?
Returns JQuery element bound to the current component.

getElementJQueryD

Link copied to clipboard

fun Component.getElementJQueryD(): dynamic
Returns JQuery element bound to the current component as a dynamic type.

getSnStyle

Link copied to clipboard

open fun getSnStyle(): dynamic
Returns CSS style attributes.

getState

Link copied to clipboard

open override fun getState(): Number?
Get current state.

getStyle

Link copied to clipboard

fun getStyle(name: String): String?
Returns the value of a custom CSS style.

getValue

Link copied to clipboard

open override fun getValue(): Number?
Returns the value of the control.

getValueAsString

Link copied to clipboard

open override fun getValueAsString(): String?
Returns the value of the control as a String.

gridPanel

Link copied to clipboard

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.

h1

Link copied to clipboard

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

h2

Link copied to clipboard

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

h3

Link copied to clipboard

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

h4

Link copied to clipboard

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

h5

Link copied to clipboard

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

h6

Link copied to clipboard

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

Link copied to clipboard

open override fun hasCssClass(css: String): Boolean
Checks whether the given value is present in the set of CSS classes.

header

Link copied to clipboard

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

Link copied to clipboard

open fun hide()
Makes current widget invisible.

hideAnim

Link copied to clipboard

fun Widget.hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)
Hides current widget with animation effect.

hidePopover

Link copied to clipboard

fun Widget.hidePopover()
Hides popover for the current widget.

hideTooltip

Link copied to clipboard

fun Widget.hideTooltip()
Hides tooltip for the current widget.

hPanel

Link copied to clipboard

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.

i

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

inheritingStyle

Link copied to clipboard

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

Link copied to clipboard

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

invoke

Link copied to clipboard

open operator fun invoke(vararg children: Component)
Operator function for adding children in a DSL style.

label

Link copied to clipboard

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

li

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

modal

Link copied to clipboard

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

nav

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

ol

Link copied to clipboard

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

onsButton

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

onsDateTime

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

onsListTitle

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

onsRange

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

onsText

Link copied to clipboard

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

Link copied to clipboard

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.

p

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

range

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open override fun remove(child: Component)
Removes given component from the current container.

removeAfterCreateHook

Link copied to clipboard

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean
Remove the after create hook function (the same function reference must be used).

removeAfterDestroyHook

Link copied to clipboard

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean
Remove the after destroy hook function (the same function reference must be used).

removeAfterInsertHook

Link copied to clipboard

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean
Remove the after insert hook function (the same function reference must be used).

removeAll

Link copied to clipboard

open override fun removeAll()
Removes all children from the current container.

removeAt

Link copied to clipboard

open override fun removeAt(position: Int)
Removes child component from the current container at the given position.

removeAttribute

Link copied to clipboard

open override fun removeAttribute(name: String)
Removes the value of additional attribute.

removeBeforeDisposeHook

Link copied to clipboard

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean
Remove the before dispose hook function (the same function reference must be used).

removeBsBgColor

Link copied to clipboard

fun Component.removeBsBgColor(bsBgColor: BsBgColor)

removeBsBorder

Link copied to clipboard

fun Component.removeBsBorder(vararg bsBorder: BsBorder)

removeBsClearfix

Link copied to clipboard

fun Component.removeBsClearfix()

removeBsColor

Link copied to clipboard

fun Component.removeBsColor(bsColor: BsColor)

removeBsRounded

Link copied to clipboard

fun Component.removeBsRounded(vararg bsRounded: BsRounded)

removeCssClass

Link copied to clipboard

open override fun removeCssClass(css: String)
Removes given value from the set of CSS classes generated in html code of current component.

removeCssStyle

Link copied to clipboard

open override fun removeCssStyle(css: Style)
Removes given style object from the set of CSS classes generated in html code of current component.

removeEventListener

Link copied to clipboard

open override fun removeEventListener(id: Int)
Removes event listener from current widget.

removeEventListeners

Link copied to clipboard

open override fun removeEventListeners()
Removes all event listeners from current widget.

removeStyle

Link copied to clipboard

fun removeStyle(name: String)
Removes the value of a custom CSS style.

removeSurroundingCssClass

Link copied to clipboard

open override fun removeSurroundingCssClass(css: String)
Removes given value from the set of CSS classes generated in html code of parent component.

removeSurroundingCssStyle

Link copied to clipboard

open override fun removeSurroundingCssStyle(css: Style)
Removes given style object from the set of CSS classes generated in html code of parent component.

responsiveGridPanel

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

ripple

Link copied to clipboard

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

Link copied to clipboard

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

section

Link copied to clipboard

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

Link copied to clipboard

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

select

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open override fun setAttribute(name: String, value: String)
Sets the value of additional attribute.

setContextMenu

Link copied to clipboard

fun Widget.setContextMenu(contextMenu: ContextMenu)
Sets context menu for the current widget.

setDragDropData

Link copied to clipboard

open fun setDragDropData(format: String, data: String)
Sets D&D data for the current widget. It also makes it draggable.

setDropTarget

Link copied to clipboard

open fun setDropTarget(format: String, callback: (<Error class: unknown class>) -> Unit)
open fun setDropTarget(formats: Set<String>? = null, callback: (<Error class: unknown class>) -> Unit)
Sets the current widget as a D&D drop target.

setDropTargetData

Link copied to clipboard

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

Link copied to clipboard

open override fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int
Sets an event listener for current widget, keeping the actual type of component.

setState

Link copied to clipboard

open override fun setState(state: Number?)
Set current state.

setStyle

Link copied to clipboard

fun setStyle(name: String, value: String)
Sets the value of a custom CSS style.

setValue

Link copied to clipboard

open override fun setValue(v: Any?)
Sets the value of the control.

show

Link copied to clipboard

open fun show()
Makes current widget visible.

showAnim

Link copied to clipboard

fun Widget.showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)
Shows current widget with animation effect.

showPopover

Link copied to clipboard

fun Widget.showPopover()
Shows popover for the current widget.

showTooltip

Link copied to clipboard

fun Widget.showTooltip()
Shows tooltip for the current widget.

simplePanel

Link copied to clipboard

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

Link copied to clipboard

open override fun <T> singleRender(block: () -> T): T
Executes given function within a single rendering process.

singleRenderAsync

Link copied to clipboard

open override fun singleRenderAsync(block: () -> Unit)
Executes given function within a single rendering process asynchronously.

slideDown

Link copied to clipboard

fun Widget.slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)
Shows current widget with slide down effect.

slideUp

Link copied to clipboard

fun Widget.slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)
Hides current widget with slide up effect.

small

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

stackPanel

Link copied to clipboard

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

strong

Link copied to clipboard

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

Link copied to clipboard

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

styleForHorizontalFormPanel

Link copied to clipboard

open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio)
Style form control element for horizontal form panel.

styleForInlineFormPanel

Link copied to clipboard

open fun styleForInlineFormPanel()
Style form control element for inline form panel.

styleForVerticalFormPanel

Link copied to clipboard

open fun styleForVerticalFormPanel()
Style form control element for vertical form panel.

sub

Link copied to clipboard

fun <S, T> ObservableState<S>.sub(contextWidget: Widget? = null, extractor: (S) -> T): ObservableState<T>
Returns a sub-store of the original ObservableState

subscribe

Link copied to clipboard

open override fun subscribe(observer: (Number?) -> Unit): () -> Unit
Subscribe for the state change notifications. Calls the observer with the current state.

switch

Link copied to clipboard

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

Link copied to clipboard

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

table

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

tabulatorRemote

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

themeSwitcher

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

toggleVisible

Link copied to clipboard

open fun toggleVisible()
Toggles visibility of current widget.

tomSelect

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

tr

Link copied to clipboard

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

translate

Link copied to clipboard

open fun translate(text: String): String
open fun translate(text: String?): String?
Translates given text with I18n trans function and sets lastLanguage marker.

triStateCheckBox

Link copied to clipboard

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

Link copied to clipboard

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

ul

Link copied to clipboard

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

unaryPlus

Link copied to clipboard

open operator fun String.unaryPlus()
An operator to add a text node to the container.

upload

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

open fun useSnabbdomDistinctKey()
Makes the component use distinct snabbdom key.

vPanel

Link copied to clipboard

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

Link copied to clipboard

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

window

Link copied to clipboard

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.