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 --- .../-select-option/-init-.html | 31 ++ .../-select-option/disabled.html | 15 + .../-select-option/divider.html | 15 + .../-select-option/get-sn-attrs.html | 18 ++ .../-select-option/icon.html | 15 + .../-select-option/index.html | 346 +++++++++++++++++++++ .../-select-option/label.html | 15 + .../-select-option/render.html | 18 ++ .../-select-option/subtext.html | 15 + .../-select-option/value.html | 15 + 10 files changed, 503 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/label.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/render.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-option/value.html (limited to 'docs/api/pl.treksoft.kvision.form.select/-select-option') diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html new file mode 100644 index 00000000..4bbd977b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/-init-.html @@ -0,0 +1,31 @@ + + + +SelectOption.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / <init>
+
+

<init>

+ +

SelectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, classes: Set<String> = setOf())

Parameters

+value - the value of the option

+label - the label of the option

+subtext - the small subtext after the label of the option

+icon - the icon before the label of the option

+divider - renders this option as a divider

+disabled - renders a disabled option

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html new file mode 100644 index 00000000..0866318c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/disabled.html @@ -0,0 +1,15 @@ + + + +SelectOption.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if the option should be disabled.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html new file mode 100644 index 00000000..8cde2f8a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/divider.html @@ -0,0 +1,15 @@ + + + +SelectOption.divider - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / divider
+
+

divider

+ +var divider: Boolean +

Determines if the option should be rendered as divider.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html new file mode 100644 index 00000000..50bea1eb --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +SelectOption.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / getSnAttrs
+
+

getSnAttrs

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

Overrides Widget.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.select/-select-option/icon.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html new file mode 100644 index 00000000..beda6b21 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/icon.html @@ -0,0 +1,15 @@ + + + +SelectOption.icon - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / icon
+
+

icon

+ +var icon: String? +

The icon before the label of the option.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/index.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/index.html new file mode 100644 index 00000000..7fd1a7f3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/index.html @@ -0,0 +1,346 @@ + + + +SelectOption - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption
+
+

SelectOption

+open class SelectOption : Widget +

The helper component for adding options to Select or SelectOptGroup.

Constructors

+ + + + + + + +

<init>

SelectOption(value: String? = null, label: String? = null, subtext: String? = null, icon: String? = null, divider: Boolean = false, disabled: Boolean = false, classes: Set<String> = setOf())

Properties

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

+ disabled +	+`var disabled: Boolean` + Determines if the option should be disabled. +
+ divider +	+`var divider: Boolean` + Determines if the option should be rendered as divider. +
+ icon +	+`var icon: String?` + The icon before the label of the option. +
+ label +	+`var label: String?` + The label of the option. +
+ subtext +	+`var subtext: String?` + The subtext after the label of the option. +
+ value +	+`var value: String?` + The value of the option. +

Inherited Properties

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

+ id +	+`var id: String?` + An ID attribute of generated HTML element. +
+ parent +	+`open var parent: Component?` + Parent of the current component. +
+ role +	+`var role: String?` + A role attribute of generated HTML element. +
+ title +	+`var title: String?` + A title attribute of generated HTML element. +
+ visible +	+`open var visible: Boolean` + Visibility state of the current component. +

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

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

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ afterPostpatch +	+`open fun afterPostpatch(node: VNode): Unit` + Method called after updating Snabbdom vnode. +
+ getElement +	+`open fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`open fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`open fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ getSnHooks +	+`open fun getSnHooks(): Hooks?` + Returns list of hooks in the form of a Snabbdom Hooks object. +
+ getSnOn +	+`open fun getSnOn(): On?` + Returns list of event handlers in the form of a Snabbdom On object. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of parent component. +
+ render +	+`open fun render(elementName: String): VNode` +`open fun render(elementName: String, children: Array<dynamic>): VNode` + Renders current component as a Snabbdom vnode. +
+ setEventListener +	+`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` + Sets an event listener for current widget, keeping the actual type of component. +`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` + Sets an event listener for current widget. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/label.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/label.html new file mode 100644 index 00000000..119a42ed --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/label.html @@ -0,0 +1,15 @@ + + + +SelectOption.label - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / label
+
+

label

+ +var label: String? +

The label of the option.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/render.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/render.html new file mode 100644 index 00000000..b548132f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/render.html @@ -0,0 +1,18 @@ + + + +SelectOption.render - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / 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.select/-select-option/subtext.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html new file mode 100644 index 00000000..44e6e06e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/subtext.html @@ -0,0 +1,15 @@ + + + +SelectOption.subtext - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / subtext
+
+

subtext

+ +var subtext: String? +

The subtext after the label of the option.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-option/value.html b/docs/api/pl.treksoft.kvision.form.select/-select-option/value.html new file mode 100644 index 00000000..c557edae --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-option/value.html @@ -0,0 +1,15 @@ + + + +SelectOption.value - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectOption / value
+
+

value

+ +var value: String? +

The value of the option.

+ + -- cgit