From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-text-input/-init-.html | 23 +++ .../-text-input/autocomplete.html | 15 ++ .../-text-input/get-sn-attrs.html | 18 ++ .../-text-input/index.html | 199 +++++++++++++++++++++ .../-text-input/render.html | 18 ++ .../-text-input/type.html | 15 ++ 6 files changed, 288 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.text/-text-input/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-text-input/autocomplete.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-text-input/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-text-input/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-text-input/render.html create mode 100644 docs/api/pl.treksoft.kvision.form.text/-text-input/type.html (limited to 'docs/api/pl.treksoft.kvision.form.text/-text-input') diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-input/-init-.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/-init-.html new file mode 100644 index 00000000..d250ec0d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/-init-.html @@ -0,0 +1,23 @@ + + + +TextInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextInput / <init>
+
+

<init>

+ +TextInput(type: TEXTINPUTTYPE = TEXTINPUTTYPE.TEXT, value: String? = null, classes: Set<String> = setOf()) +

Parameters

+type - text input type (default "text")

+value - text input value

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-input/autocomplete.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/autocomplete.html new file mode 100644 index 00000000..01ef482c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/autocomplete.html @@ -0,0 +1,15 @@ + + + +TextInput.autocomplete - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextInput / autocomplete
+
+

autocomplete

+ +var autocomplete: Boolean? +

Determines if autocomplete is enabled for the input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-input/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/get-sn-attrs.html new file mode 100644 index 00000000..02865712 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +TextInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextInput / 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/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html new file mode 100644 index 00000000..3ebaf3e8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html @@ -0,0 +1,199 @@ + + + +TextInput - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextInput
+
+

TextInput

+open class TextInput : AbstractTextInput +

Basic text component.

Constructors

+ + + + + + + +

<init>

+TextInput(type: TEXTINPUTTYPE = TEXTINPUTTYPE.TEXT, value: String? = null, classes: Set<String> = setOf())

Properties

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

+ autocomplete +	+`var autocomplete: Boolean?` + Determines if autocomplete is enabled for the input element. +
+ type +	+`var type: TEXTINPUTTYPE` + Text input type. +

Inherited Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ disabled +	+`var disabled: Boolean` + Determines if the field is disabled. +
+ maxlength +	+`var maxlength: Int?` + Maximal length of the text input value. +
+ name +	+`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 +	+`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. +

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-input/render.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/render.html new file mode 100644 index 00000000..9c969109 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/render.html @@ -0,0 +1,18 @@ + + + +TextInput.render - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextInput / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-input/type.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/type.html new file mode 100644 index 00000000..11252562 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/type.html @@ -0,0 +1,15 @@ + + + +TextInput.type - kvision + + + +kvision / pl.treksoft.kvision.form.text / TextInput / type
+
+

type

+ +var type: TEXTINPUTTYPE +

Text input type.

+ + -- cgit