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 --- .../-range/get-state.html | 15 ++ .../-range/index.html | 259 +++++++++++++++------ .../-range/subscribe.html | 15 ++ 3 files changed, 221 insertions(+), 68 deletions(-) create mode 100644 api/pl.treksoft.kvision.form.range/-range/get-state.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/subscribe.html (limited to 'api/pl.treksoft.kvision.form.range/-range') diff --git a/api/pl.treksoft.kvision.form.range/-range/get-state.html b/api/pl.treksoft.kvision.form.range/-range/get-state.html new file mode 100644 index 00000000..f6ca5eb8 --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/get-state.html @@ -0,0 +1,15 @@ + + + +Range.getState - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range / getState
+
+

getState

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

Get current state.

+ + diff --git a/api/pl.treksoft.kvision.form.range/-range/index.html b/api/pl.treksoft.kvision.form.range/-range/index.html index 458e70a6..d57a5490 100644 --- a/api/pl.treksoft.kvision.form.range/-range/index.html +++ b/api/pl.treksoft.kvision.form.range/-range/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / Range

Range

-(js) open class Range : SimplePanel, NumberFormControl +(js) open class Range : SimplePanel, NumberFormControl, ObservableState<Number?>

The form field component for range input control.

Constructors

@@ -186,6 +186,15 @@ + + + + + + + +

(js) + getState +	+ Get current state. +`open fun getState(): Number?`
+(js) getValueAsString	@@ -246,6 +255,15 @@ Style form control element for horizontal form panel. `open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio): Unit`
+(js) + subscribe +	+ Subscribe for the state change notifications. +`open fun subscribe(observer: (Number?) -> Unit): () -> Unit`

Extension Properties

@@ -257,6 +275,7 @@

changeFlow

+

Extension property returning Flow for a change event.

val <T : Widget> T.changeFlow: Flow<T> @@ -265,6 +284,7 @@

clickFlow

+

Extension property returning Flow for a click event.

val <T : Widget> T.clickFlow: Flow<T> @@ -273,8 +293,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

@@ -323,11 +353,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

@@ -336,7 +375,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

@@ -345,7 +384,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

@@ -354,7 +393,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

@@ -363,7 +402,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

@@ -381,7 +420,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

@@ -390,7 +429,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

@@ -399,7 +438,7 @@

DSL builder extension function.

-fun Container.customTag(elementName: String, content: