kvision / pl.treksoft.kvision.html / Button

Button

(js) open class Button : Widget

Button component.

Constructors

(js)

<init>

Button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf())

Properties

(js)

block

Determines if the button takes all the space horizontally.

var block: Boolean
(js)

disabled

Determines if button is disabled.

var disabled: Boolean
(js)

icon

Button icon.

var icon: String?
(js)

image

Button image.

var image: ResString?
(js)

size

Button size.

var size: ButtonSize?
(js)

style

Button style.

var style: ButtonStyle
(js)

text

Button label.

var text: String
(js)

type

Button types.

var type: ButtonType

Functions

(js)

blur

Makes the button blur.

open fun blur(): Unit
(js)

focus

Makes the button focused.

open fun focus(): Unit
(js)

getSnAttrs

Returns list of element attributes in the form of a List.

open fun getSnAttrs(): List<StringPair>
(js)

getSnClass

Returns list of CSS class names for current widget in the form of a List.

open fun getSnClass(): List<StringBoolPair>
(js)

onClick

A convenient helper for easy setting onClick event handler.

open fun onClick(handler: Button.(MouseEvent) -> Unit): Button
(js)

render

Renders current component as a Snabbdom vnode.

open fun render(): VNode

Extension Properties

(js)

changeFlow

val <T : Widget> T.changeFlow: Flow<T>
(js)

clickFlow

val <T : Widget> T.clickFlow: Flow<T>
(js)

inputFlow

val <T : Widget> T.inputFlow: Flow<T>

Extension Functions

(js)

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit
(js)

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit
(js)

addBsClearfix

fun Component.addBsClearfix(): Unit
(js)

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit
(js)

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit
(js)

contextMenu

DSL builder extension function.

fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu
(js)

eventFlow

fun <T : Widget> T.eventFlow(event: String): Flow<Pair<T, Event>>
(js)

onEvent

fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int
(js)

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit
(js)

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit
(js)

removeBsClearfix

fun Component.removeBsClearfix(): Unit
(js)

removeBsColor

fun Component.removeBsColor(bsColor: BsColor): Unit
(js)

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit
(js)

setContextMenu

Sets context menu for the current widget.

fun Widget.setContextMenu(contextMenu: ContextMenu): Widget
(js)

style

DSL builder extension function.

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