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 --- .../-text-area-input/-init-.html | 25 +++ .../-text-area-input/cols.html | 21 ++ .../-text-area-input/get-sn-attrs.html | 18 ++ .../-text-area-input/index.html | 236 +++++++++++++++++++++ .../-text-area-input/render.html | 18 ++ .../-text-area-input/rows.html | 21 ++ .../-text-area-input/text-area-input.html | 16 ++ .../-text-area-input/wrap-hard.html | 21 ++ 8 files changed, 376 insertions(+) create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/-init-.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/cols.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/get-sn-attrs.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/index.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/render.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/rows.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/text-area-input.html create mode 100644 api1/pl.treksoft.kvision.form.text/-text-area-input/wrap-hard.html (limited to 'api1/pl.treksoft.kvision.form.text/-text-area-input') diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/-init-.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/-init-.html new file mode 100644 index 00000000..b97eca51 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/-init-.html @@ -0,0 +1,25 @@ + + + +TextAreaInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / <init>
+
+

<init>

+ +TextAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, classes: Set<String> = setOf()) +

Parameters

+cols - number of columns

+rows - number of rows

+value - text input value

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/cols.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/cols.html new file mode 100644 index 00000000..bb10e4d8 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/cols.html @@ -0,0 +1,21 @@ + + + +TextAreaInput.cols - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / cols
+
+

cols

+ +var cols: Int? +

Number of columns.

Getter
+

Number of columns.

Setter
+

Number of columns.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/get-sn-attrs.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/get-sn-attrs.html new file mode 100644 index 00000000..454e13de --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +TextAreaInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Overrides AbstractTextInput.getSnAttrs

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

Return
+list of element attributes

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/index.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/index.html new file mode 100644 index 00000000..83eac4a8 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/index.html @@ -0,0 +1,236 @@ + + + +TextAreaInput - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput
+
+

TextAreaInput

+open class TextAreaInput : AbstractTextInput +

Basic textarea component.

Constructors

+ + + + + + + +

<init>

+TextAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, classes: Set<String> = setOf())

Properties

+ + + + + + + + + + + + + + + +

+ cols +	+`var cols: Int?` + Number of columns. +
+ rows +	+`var rows: Int?` + Number of rows. +
+ wrapHard +	+`var wrapHard: Boolean` + Determines if hard wrapping is enabled for the textarea element. +

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ maxlength +	+`var maxlength: Int?` + Maximal length of the text input value. +
+ name +	+`open var name: String?` + The name attribute of the generated HTML input element. +
+ placeholder +	+`var placeholder: String?` + The placeholder for the text input. +
+ readonly +	+`var readonly: Boolean?` + Determines if the text input is read-only. +
+ size +	+`open var size: InputSize?` + The size of the input. +
+ startValue +	+`var startValue: String?` + The value attribute of the generated HTML input element. +
+ value +	+`var value: String?` + Text input value. +

Functions

+ + + + + + + + + + + +

+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Inherited Functions

+ + + + + + + + + + + + + + + + + + + +

+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +

Companion Object Functions

+ + + + + + + +

textAreaInput

fun Container.textAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, classes: Set<String> = setOf(), init: (TextAreaInput.() -> Unit)? = null): TextAreaInput

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/render.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/render.html new file mode 100644 index 00000000..d38d0d73 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/render.html @@ -0,0 +1,18 @@ + + + +TextAreaInput.render - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/rows.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/rows.html new file mode 100644 index 00000000..5f0697f0 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/rows.html @@ -0,0 +1,21 @@ + + + +TextAreaInput.rows - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / rows
+
+

rows

+ +var rows: Int? +

Number of rows.

Getter
+

Number of rows.

Setter
+

Number of rows.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/text-area-input.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/text-area-input.html new file mode 100644 index 00000000..a4a3bc7c --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/text-area-input.html @@ -0,0 +1,16 @@ + + + +TextAreaInput.textAreaInput - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / textAreaInput
+
+

textAreaInput

+ +

fun Container.textAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, classes: Set<String> = setOf(), init: (TextAreaInput.() -> Unit)? = null): TextAreaInput

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api1/pl.treksoft.kvision.form.text/-text-area-input/wrap-hard.html b/api1/pl.treksoft.kvision.form.text/-text-area-input/wrap-hard.html new file mode 100644 index 00000000..782b9997 --- /dev/null +++ b/api1/pl.treksoft.kvision.form.text/-text-area-input/wrap-hard.html @@ -0,0 +1,21 @@ + + + +TextAreaInput.wrapHard - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextAreaInput / wrapHard
+
+

wrapHard

+ +var wrapHard: Boolean +

Determines if hard wrapping is enabled for the textarea element.

Getter
+

Determines if hard wrapping is enabled for the textarea element.

Setter
+

Determines if hard wrapping is enabled for the textarea element.

+ + -- cgit