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 --- api1/pl.treksoft.kvision.html/-icon/-init-.html | 19 +++ .../-icon/get-sn-class.html | 18 +++ api1/pl.treksoft.kvision.html/-icon/icon.html | 25 +++ api1/pl.treksoft.kvision.html/-icon/index.html | 172 +++++++++++++++++++++ 4 files changed, 234 insertions(+) create mode 100644 api1/pl.treksoft.kvision.html/-icon/-init-.html create mode 100644 api1/pl.treksoft.kvision.html/-icon/get-sn-class.html create mode 100644 api1/pl.treksoft.kvision.html/-icon/icon.html create mode 100644 api1/pl.treksoft.kvision.html/-icon/index.html (limited to 'api1/pl.treksoft.kvision.html/-icon') diff --git a/api1/pl.treksoft.kvision.html/-icon/-init-.html b/api1/pl.treksoft.kvision.html/-icon/-init-.html new file mode 100644 index 00000000..08671b45 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/-init-.html @@ -0,0 +1,19 @@ + + + +Icon.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / Icon / <init>
+
+

<init>

+ +Icon(icon: String) +

Parameters

+icon - icon name

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.html/-icon/get-sn-class.html b/api1/pl.treksoft.kvision.html/-icon/get-sn-class.html new file mode 100644 index 00000000..ae52c838 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Icon.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.html / Icon / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Tag.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
+list of CSS class names

+ + diff --git a/api1/pl.treksoft.kvision.html/-icon/icon.html b/api1/pl.treksoft.kvision.html/-icon/icon.html new file mode 100644 index 00000000..3ed999be --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/icon.html @@ -0,0 +1,25 @@ + + + +Icon.icon - kvision + + + +kvision / pl.treksoft.kvision.html / Icon / icon
+
+

icon

+ +var icon: String +

Icon type.

Getter
+

Icon type.

Setter
+

Icon type.

+ +fun Container.icon(icon: String, init: (Icon.() -> Unit)? = null): Icon +

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.html/-icon/index.html b/api1/pl.treksoft.kvision.html/-icon/index.html new file mode 100644 index 00000000..4f9b2ad9 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-icon/index.html @@ -0,0 +1,172 @@ + + + +Icon - kvision + + + +kvision / pl.treksoft.kvision.html / Icon
+
+

Icon

+open class Icon : Tag +

Icon component with support for FontAwesome and Bootstrap glyphicons.

Constructors

+ + + + + + + +

<init>

+Icon(icon: String)

Properties

+ + + + + + + +

icon

+var icon: String +

Icon type.

Inherited Properties

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

+ align +	+`var align: Align?` + Text align. +
+ content +	+`open var content: String?` + Text content of the tag. +
+ rich +	+`open var rich: Boolean` + Determines if content can contain HTML code. +
+ template +	+`open var template: ((Any?) -> String)?` + Handlebars template. +
+ templates +	+`open var templates: Map<String, (Any?) -> String>` + Handlebars templates for i18n. +
+ type +	+`var type: TAG` + Tag type. +

Functions

+ + + + + + + +

getSnClass

+open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

Inherited Functions

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

+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ unaryPlus +	+`operator fun String.unaryPlus(): Unit`

Companion Object Functions

+ + + + + + + +

icon

+fun Container.icon(icon: String, init: (Icon.() -> Unit)? = null): Icon +

DSL builder extension function.

Extension Functions

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

+ createInstance +	+`fun <T> Any?.createInstance(vararg args: dynamic): T` + Helper function for creating JavaScript objects from dynamic constructors. +
+ setData +	+`fun <K> Template.setData(obj: K, serializer: SerializationStrategy<K>): Unit` +`fun <K : Any> Template.setData(obj: K): Unit` + Extension function to set serializable object as a template data. +

+ + -- cgit