From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-select-remote/-init-.html | 6 +- .../-select-remote/dropdown-align.html | 15 + .../-select-remote/index.html | 801 ++++++++++++++++++++- .../-select-remote/invalid-feedback.html | 16 + .../-select-remote/select-remote.html | 16 - .../-select-remote/validation-info.html | 16 - 6 files changed, 820 insertions(+), 50 deletions(-) create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/invalid-feedback.html delete mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/select-remote.html delete mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/validation-info.html (limited to 'api/pl.treksoft.kvision.form.select/-select-remote') diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html b/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html index 273bf455..ac20a519 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / <init>

<init>

- -SelectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false) + +SelectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: suspend T.(String?, String?, String?) -> List<<ERROR CLASS>>, stateFunction: (() -> String)? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false)

Parameters

value - selected value

@@ -17,6 +17,8 @@ serviceManager - multiplatform service manager

function - multiplatform service method returning the list of options

+

+stateFunction - a function to generate the state object passed with the remote request

name - the name attribute of the generated HTML input element

diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html b/api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html new file mode 100644 index 00000000..cb66d6eb --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html @@ -0,0 +1,15 @@ + + + +SelectRemote.dropdownAlign - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote / dropdownAlign
+
+

dropdownAlign

+ +var dropdownAlign: SelectDropdownAlign +

The dropdown align of the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/index.html b/api/pl.treksoft.kvision.form.select/-select-remote/index.html index 19275a04..325fffb5 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/index.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/index.html @@ -18,7 +18,7 @@

<init>

-SelectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false) +SelectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: suspend T.(String?, String?, String?) -> List<<ERROR CLASS>>, stateFunction: (() -> String)? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false) @@ -36,6 +36,15 @@ +

dropdownAlign

+ + +var dropdownAlign: SelectDropdownAlign +

The dropdown align of the select control.

+ + + +

emptyOption

@@ -63,6 +72,15 @@ +

invalidFeedback

+ + +val invalidFeedback: InvalidFeedback +

Invalid feedback component.

+ + + +

label

@@ -135,21 +153,24 @@ -

validationInfo

+

value

-val validationInfo: HelpBlock -

Validation info component.

+open var value: String? +

A value of the selected option.

+ + +

Inherited Properties

+ + +val children: MutableList<Component>
-

value

+

children

-open var value: String? -

A value of the selected option.

-
@@ -336,23 +357,116 @@ -

Companion Object Functions

+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

selectRemote

+

addBsBgColor

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

addBsBorder

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

addBsClearfix

+
+fun Component.addBsClearfix(): Unit
+

addBsColor

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

addBsRounded

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

bold

-fun <T : Any> Container.selectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: (SelectRemote<T>.() -> Unit)? = null): SelectRemote<T> +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold +

DSL builder extension function.

+
+

button

+
+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 +

DSL builder extension function.

+
+

buttonGroup

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

DSL builder extension function.

+
+

canvas

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

DSL builder extension function.

+
+

chart

+
+fun Conta