kvision/io.kvision.core/Widget

Widget

open class Widget(className: String? = null, init: Widget.() -> Unit? = null) : StyledComponent, Component

Base widget class. The parent of all component classes.

A simple widget is rendered as HTML DIV element.

Parameters

className

CSS class names

init

an initializer extension function

Inheritors

Constructors

Link copied to clipboard
constructor(className: String? = null, init: Widget.() -> Unit? = null)

Creates basic Widget with given CSS class names.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open var alignContent: AlignContent?

CSS flexbox/grid content alignment.

Link copied to clipboard
open var alignItems: AlignItems?

CSS flexbox/grid items alignment.

Link copied to clipboard
open var alignSelf: AlignItems?

CSS flexbox items self-alignment.

Link copied to clipboard
open var background: Background?

Background of the current component.

Link copied to clipboard
open var border: Border?

Border of the current component.

Link copied to clipboard
open var borderBottom: Border?

Bottom border of the current component.

Link copied to clipboard
open var borderLeft: Border?

Left border of the current component.

Link copied to clipboard
open var borderRadius: <Error class: unknown class><Number, UNIT>?

CSS border radius.

Link copied to clipboard
open var borderRadiusList: List<<Error class: unknown class><Number, UNIT>>?

List of CSS border radius values.

Link copied to clipboard
open var borderRight: Border?

Right border of the current component.

Link copied to clipboard
open var borderTop: Border?

Top border of the current component.

Link copied to clipboard
open var bottom: <Error class: unknown class><Number, UNIT>?

Bottom edge of the current component.

Link copied to clipboard
open var boxShadow: BoxShadow?

Box shadow of the current component.

Link copied to clipboard
open var boxShadowList: List<BoxShadow>?

List of box shadows of the current component.

Link copied to clipboard
open var clear: Clear?

CSS clear float of the current component.

Link copied to clipboard
open var color: Color?

Text color for the current component.

Link copied to clipboard
open var colorHex: Int?

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

Link copied to clipboard
open var colorName: Col?

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

Link copied to clipboard
open var cursor: Cursor?

CSS cursor shape over the current component.

Link copied to clipboard
open var display: Display?

CSS display of the current component.

Link copied to clipboard
var draggable: Boolean?

Determines if the current widget is draggable.

Link copied to clipboard
var eventTarget: Widget?
Link copied to clipboard
open var flexBasis: <Error class: unknown class><Number, UNIT>?

CSS flexbox item basis.

Link copied to clipboard
open var flexDirection: FlexDirection?

CSS flexbox direction.

Link copied to clipboard
open var flexGrow: Int?

CSS flexbox item grow.

Link copied to clipboard
open var flexShrink: Int?

CSS flexbox item shrink.

Link copied to clipboard
open var flexWrap: FlexWrap?

CSS flexbox wrap mode.

Link copied to clipboard
open var float: PosFloat?

CSS position float of the current component.

Link copied to clipboard
open var fontFamily: String?

CSS font family of the current component.

Link copied to clipboard
open var fontSize: <Error class: unknown class><Number, UNIT>?

CSS font size of the current component.

Link copied to clipboard
open var fontStyle: FontStyle?

CSS font style of the current component.

Link copied to clipboard
open var fontVariant: FontVariant?

CSS font variant of the current component.

Link copied to clipboard
open var fontWeight: FontWeight?

CSS font weight of the current component.

Link copied to clipboard
open var gridArea: String?

CSS grid area.

Link copied to clipboard
open var gridAutoColumns: String?

CSS grid auto columns.

Link copied to clipboard
open var gridAutoFlow: GridAutoFlow?

CSS grid auto flow.

Link copied to clipboard
open var gridAutoRows: String?

CSS grid auto rows.

Link copied to clipboard
open var gridColumnEnd: String?

CSS grid column end.

Link copied to clipboard
open var gridColumnGap: Int?

CSS grid column gap.

Link copied to clipboard
open var gridColumnStart: Int?

CSS grid column start.

Link copied to clipboard
open var gridRowEnd: String?

CSS grid row end.

Link copied to clipboard
open var gridRowGap: Int?

CSS grid row gap.

Link copied to clipboard
open var gridRowStart: Int?

CSS grid row start.

Link copied to clipboard
open var gridTemplateAreas: List<String>?

CSS grid areas template.

Link copied to clipboard
open var gridTemplateColumns: String?

CSS grid columns template.

Link copied to clipboard
open var gridTemplateRows: String?

CSS grid rows template.

Link copied to clipboard
open var height: <Error class: unknown class><Number, UNIT>?

Height of the current component.

Link copied to clipboard
var id: String?

An ID attribute of generated HTML element.

Link copied to clipboard
open var justifyContent: JustifyContent?

CSS flexbox/grid content justification.

Link copied to clipboard
open var justifyItems: JustifyItems?

CSS grid items justification.

Link copied to clipboard
open var justifySelf: JustifyItems?

CSS grid items self-justification.

Link copied to clipboard
var kvscope: dynamic
Link copied to clipboard
open var left: <Error class: unknown class><Number, UNIT>?

Left edge of the current component.

Link copied to clipboard
open var letterSpacing: <Error class: unknown class><Number, UNIT>?

CSS Text letter spacing of the current component.

Link copied to clipboard
open var lineBreak: LineBreak?

CSS line break of the current component.

Link copied to clipboard
open var lineHeight: <Error class: unknown class><Number, UNIT>?

CSS Text line height of the current component.

Link copied to clipboard
open var listStyle: ListStyle?

List style of the current component.

Link copied to clipboard
open var margin: <Error class: unknown class><Number, UNIT>?

Margin of the current component.

Link copied to clipboard
open var marginBottom: <Error class: unknown class><Number, UNIT>?

Bottom margin of the current component.

Link copied to clipboard
open var marginLeft: <Error class: unknown class><Number, UNIT>?

Left margin of the current component.

Link copied to clipboard
open var marginRight: <Error class: unknown class><Number, UNIT>?

Right margin of the current component.

Link copied to clipboard
open var marginTop: <Error class: unknown class><Number, UNIT>?

Top margin of the current component.

Link copied to clipboard
open var maxHeight: <Error class: unknown class><Number, UNIT>?

Maximal height of the current component.

Link copied to clipboard
open var maxWidth: <Error class: unknown class><Number, UNIT>?

Maximal width of the current component.

Link copied to clipboard
open var minHeight: <Error class: unknown class><Number, UNIT>?

Minimal height of the current component.

Link copied to clipboard
open var minWidth: <Error class: unknown class><Number, UNIT>?

Minimal width of the current component.

Link copied to clipboard
open var opacity: Double?

Opacity of the current component.

Link copied to clipboard
open var order: Int?

CSS flexbox item order.

Link copied to clipboard
open var outline: Outline?

Outline of the current component.

Link copied to clipboard
open var overflow: Overflow?

CSS overflow of the current component.

Link copied to clipboard
open var overflowWrap: OverflowWrap?

CSS overflow-wrap of the current component.

Link copied to clipboard
open var overflowX: Overflow?

CSS overflow-x of the current component.

Link copied to clipboard
open var overflowY: Overflow?

CSS overflow-y of the current component.

Link copied to clipboard
open var padding: <Error class: unknown class><Number, UNIT>?

Padding of the current component.

Link copied to clipboard
open var paddingBottom: <Error class: unknown class><Number, UNIT>?

Bottom padding of the current component.

Link copied to clipboard
open var paddingLeft: <Error class: unknown class><Number, UNIT>?

Left padding of the current component.

Link copied to clipboard
open var paddingRight: <Error class: unknown class><Number, UNIT>?

Right padding of the current component.

Link copied to clipboard
open var paddingTop: <Error class: unknown class><Number, UNIT>?

Top padding of the current component.

Link copied to clipboard
open override var parent: Container?

Parent of the current component.

Link copied to clipboard
Link copied to clipboard
var popoverOptions: dynamic
Link copied to clipboard
open var position: Position?

CSS position of the current component.

Link copied to clipboard
open var resize: Resize?

CSS resize of the current component.

Link copied to clipboard
open var right: <Error class: unknown class><Number, UNIT>?

Right edge of the current component.

Link copied to clipboard
var role: String?

A role attribute of generated HTML element.

Link copied to clipboard
var tabindex: Int?

A tabindex attribute of generated HTML element.

Link copied to clipboard
open var textAlign: TextAlign?

CSS Text align of the current component.

Link copied to clipboard
open var textDecoration: TextDecoration?

CSS Text decoration of the current component.

Link copied to clipboard
open var textDirection: Direction?

CSS Text direction of the current component.

Link copied to clipboard
open var textIndent: <Error class: unknown class><Number, UNIT>?

CSS Text indent of the current component.

Link copied to clipboard
open var textOverflow: TextOverflow?

CSS Text overflow of the current component.

Link copied to clipboard
open var textShadow: TextShadow?

CSS Text shadow of the current component.

Link copied to clipboard
open var textTransform: TextTransform?

CSS Text transform of the current component.

Link copied to clipboard
var title: String?

A title attribute of generated HTML element.

Link copied to clipboard
Link copied to clipboard
var tooltipOptions: dynamic
Link copied to clipboard
open var top: <Error class: unknown class><Number, UNIT>?

Top edge of the current component.

Link copied to clipboard
open var transition: Transition?

CSS transition effect for the current component.

Link copied to clipboard
open var transitionList: List<Transition>?

List of CSS transition effects for the current component.

Link copied to clipboard
open var unicodeBidi: UnicodeBidi?

CSS Text unicode-bidi of the current component.

Link copied to clipboard
open var verticalAlign: VerticalAlign?

CSS Text vertical align of the current component.

Link copied to clipboard
open override var visible: Boolean

Visibility state of the current component.

Link copied to clipboard
open var whiteSpace: WhiteSpace?

CSS Text white space of the current component.

Link copied to clipboard
open var width: <Error class: unknown class><Number, UNIT>?

Width of the current component.

Link copied to clipboard
open var wordBreak: WordBreak?

CSS word break of the current component.

Link copied to clipboard
open var wordSpacing: <Error class: unknown class><Number, UNIT>?

CSS Text word spacing of the current component.

Link copied to clipboard
open var zIndex: Int?

Z-index of the current component.

Functions

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.

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.

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.

Link copied to clipboard
open override fun addBeforeDisposeHook(hook: () -> Unit): <Error class: unknown class>

The supplied function is called before the widget is disposed.

Link copied to clipboard
fun Component.addBsBgColor(bsBgColor: BsBgColor)
Link copied to clipboard
fun Component.addBsBorder(vararg bsBorder: BsBorder)
Link copied to clipboard
Link copied to clipboard
fun Component.addBsColor(bsColor: BsColor)
Link copied to clipboard
fun Component.addBsRounded(vararg bsRounded: BsRounded)
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.

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.

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.

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.

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.

Link copied to clipboard
open fun blur()

Makes the element blur.

Link copied to clipboard
open override fun clearAfterCreateHooks()

Remove all after create hooks functions.

Link copied to clipboard
open override fun clearAfterDestroyHooks()

Remove all after destroy hooks functions.

Link copied to clipboard
open override fun clearAfterInsertHooks()

Remove all after insert hooks functions.

Link copied to clipboard
open override fun clearBeforeDisposeHooks()

Remove all before dispose hooks functions.

Link copied to clipboard
open fun clearDragDropData()

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

Link copied to clipboard
fun Widget.contextMenu(fixedPosition: Boolean = false, className: String? = null, init: ContextMenu.() -> Unit? = null): ContextMenu

DSL builder extension function.

Link copied to clipboard
fun Widget.disablePopover()

Disables popover for the current widget.

Link copied to clipboard
fun Widget.disableTooltip()

Disables tooltip for the current widget.

Link copied to clipboard
open fun dispatchEvent(type: String, eventInitDict: <Error class: unknown class>): Boolean?

Dispatches a custom event.

Link copied to clipboard
fun Widget.enableGestureDetector()

Enable gesture detector for a given Widget.

Link copied to clipboard
fun Widget.enablePopover(options: PopoverOptions = PopoverOptions())

Enables popover for the current widget.

Link copied to clipboard
fun Widget.enableTooltip(options: TooltipOptions = TooltipOptions())

Enables tooltip for the current widget.

Link copied to clipboard
fun Widget.fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)

Shows current widget with fade in effect.

Link copied to clipboard
fun Widget.fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)

Hides current widget with fade out effect.

Link copied to clipboard
open fun focus()

Makes the element focused.

Link copied to clipboard
open override fun getAttribute(name: String): String?

Returns the value of an additional attribute.

Link copied to clipboard
open override fun getElement(): <Error class: unknown class>?

Returns DOM element bound to the current component.

Link copied to clipboard
open override fun getElementD(): dynamic

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

Link copied to clipboard
fun Component.getElementJQuery(): <Error class: unknown class>?

Returns JQuery element bound to the current component.

Link copied to clipboard
fun Component.getElementJQueryD(): dynamic

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

Link copied to clipboard
open fun getSnStyle(): dynamic

Returns CSS style attributes.

Link copied to clipboard
fun getStyle(name: String): String?

Returns the value of a custom CSS style.

Link copied to clipboard
open override fun hasCssClass(css: String): Boolean

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

Link copied to clipboard
open fun hide()

Makes current widget invisible.

Link copied to clipboard
fun Widget.hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)

Hides current widget with animation effect.

Link copied to clipboard
fun Widget.hidePopover()

Hides popover for the current widget.

Link copied to clipboard
fun Widget.hideTooltip()

Hides tooltip for the current widget.

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.

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

Link copied to clipboard
open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

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

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

Link copied to clipboard
open override fun removeAttribute(name: String)

Removes the value of additional attribute.

Link copied to clipboard
open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

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

Link copied to clipboard
fun Component.removeBsBgColor(bsBgColor: BsBgColor)
Link copied to clipboard
fun Component.removeBsBorder(vararg bsBorder: BsBorder)
Link copied to clipboard
Link copied to clipboard
fun Component.removeBsColor(bsColor: BsColor)
Link copied to clipboard
fun Component.removeBsRounded(vararg bsRounded: BsRounded)
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.

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.

Link copied to clipboard
open fun removeEventListener(id: Int)

Removes event listener from current widget.

Link copied to clipboard
open fun removeEventListeners()

Removes all event listeners from current widget.

Link copied to clipboard
fun removeStyle(name: String)

Removes the value of a custom CSS style.

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.

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.

Link copied to clipboard
open override fun setAttribute(name: String, value: String)

Sets the value of additional attribute.

Link copied to clipboard
fun Widget.setContextMenu(contextMenu: ContextMenu)

Sets context menu for the current widget.

Link copied to clipboard
open fun setDragDropData(format: String, data: String)

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

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.

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.

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

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

Link copied to clipboard
fun setStyle(name: String, value: String)

Sets the value of a custom CSS style.

Link copied to clipboard
open fun show()

Makes current widget visible.

Link copied to clipboard
fun Widget.showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)

Shows current widget with animation effect.

Link copied to clipboard
fun Widget.showPopover()

Shows popover for the current widget.

Link copied to clipboard
fun Widget.showTooltip()

Shows tooltip for the current widget.

Link copied to clipboard
open override fun <T> singleRender(block: () -> T): T

Executes given function within a single rendering process.

Link copied to clipboard
open override fun singleRenderAsync(block: () -> Unit)

Executes given function within a single rendering process asynchronously.

Link copied to clipboard
fun Widget.slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)

Shows current widget with slide down effect.

Link copied to clipboard
fun Widget.slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null)

Hides current widget with slide up effect.

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.

Link copied to clipboard
open fun toggleVisible()

Toggles visibility of current widget.

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.

Link copied to clipboard
open fun useSnabbdomDistinctKey()

Makes the component use distinct snabbdom key.