From bfd5aa358e141d6c86d476d8bb66b104a80a3b96 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 21 May 2020 00:13:50 +0200 Subject: API documentation for KVision 3.10.0 --- .../-simple-select-input/get-state.html | 15 ++ .../-simple-select-input/index.html | 267 +++++++++++++++------ .../-simple-select-input/observers.html | 14 ++ .../-simple-select-input/subscribe.html | 15 ++ 4 files changed, 243 insertions(+), 68 deletions(-) create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/get-state.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/observers.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/subscribe.html (limited to 'api/pl.treksoft.kvision.form.select/-simple-select-input') diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/get-state.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/get-state.html new file mode 100644 index 00000000..03915e0c --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/get-state.html @@ -0,0 +1,15 @@ + + + +SimpleSelectInput.getState - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / getState
+
+

getState

+(js) +open fun getState(): String? +

Get current state.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html index 7abd245d..52feb203 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput

SimpleSelectInput

-(js) open class SimpleSelectInput : SimplePanel, FormInput +(js) open class SimpleSelectInput : SimplePanel, FormInput, ObservableState<String?>

Simple select component.

Constructors

@@ -65,6 +65,14 @@ + + + + + + + + + + + +
(js) +

observers

+		 +val observers: MutableList<(String?) -> Unit>
+(js)

options

 @@ -160,12 +168,30 @@
(js) +

getState

+		 +

Get current state.

+open fun getState(): String?
+(js)

render

Renders current component as a Snabbdom vnode.

open fun render(): VNode
+(js) +

subscribe

+		 +

Subscribe for the state change notifications.

+open fun subscribe(observer: (String?) -> Unit): () -> Unit

Extension Properties

@@ -177,6 +203,7 @@

changeFlow

+

Extension property returning Flow for a change event.

val <T : Widget> T.changeFlow: Flow<T> @@ -185,6 +212,7 @@

clickFlow

+

Extension property returning Flow for a click event.

val <T : Widget> T.clickFlow: Flow<T> @@ -193,8 +221,18 @@

inputFlow

+

Extension property returning Flow for an input event.

val <T : Widget> T.inputFlow: Flow<T> + + +(js) +

stateFlow

+ + +

Extension property returning StateFlow for an ObservableState.

+val <S> ObservableState<S>.stateFlow: StateFlow<S> +

Extension Functions

@@ -243,11 +281,20 @@ (js) +

bind

+ + +

An extension function which binds the widget to the observable state.

+fun <S, W : Widget> W.bind(observableState: ObservableState<S>, factory: W.(S) -> Unit): W + + + +(js)

bold

DSL builder extension function.

-fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String>? = null, className: String? = null, init: (Bold.() -> Unit)? = null): Bold @@ -256,7 +303,7 @@

DSL builder extension function.

-fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, separator: String? = null, labelFirst: Boolean = true, classes: Set<String>? = null, className: String? = null, init: (Button.() -> Unit)? = null): Button @@ -265,7 +312,7 @@

DSL builder extension function.

-fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup +fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String>? = null, className: String? = null, init: (ButtonGroup.() -> Unit)? = null): ButtonGroup @@ -274,7 +321,7 @@

DSL builder extension function.

-fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas +fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String>? = null, className: String? = null, init: (Canvas.() -> Unit)? = null): Canvas @@ -283,7 +330,7 @@

DSL builder extension function.

-fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: (Chart.() -> Unit)? = null): Chart +fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String>? = null, className: String? = null, init: (Chart.() -> Unit)? = null): Chart @@ -301,7 +348,7 @@

DSL builder extension function.

-fun Container.checkBoxInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): CheckBoxInput +fun Container.checkBoxInput(value: Boolean = false, classes: Set<String>? = null, className: String? = null, init: (CheckInput.() -> Unit)? = null): CheckBoxInput @@ -310,7 +357,7 @@

DSL builder extension function.

-fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu +fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String>? = null, className: String? = null, init: (ContextMenu.() -> Unit)? = null): ContextMenu @@ -319,7 +366,7 @@

DSL builder extension function.

-fun Container.customTag(