From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../pl.treksoft.kvision.html/-icon/-init-.html | 19 +++ .../-icon/get-sn-class.html | 18 +++ .../pl.treksoft.kvision.html/-icon/icon.html | 25 ++++ .../pl.treksoft.kvision.html/-icon/index.html | 141 +++++++++++++++++++++ 4 files changed, 203 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.html/-icon/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.html/-icon/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.html/-icon/icon.html create mode 100644 api/kvision/pl.treksoft.kvision.html/-icon/index.html (limited to 'api/kvision/pl.treksoft.kvision.html/-icon') diff --git a/api/kvision/pl.treksoft.kvision.html/-icon/-init-.html b/api/kvision/pl.treksoft.kvision.html/-icon/-init-.html new file mode 100644 index 00000000..08671b45 --- /dev/null +++ b/api/kvision/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/api/kvision/pl.treksoft.kvision.html/-icon/get-sn-class.html b/api/kvision/pl.treksoft.kvision.html/-icon/get-sn-class.html new file mode 100644 index 00000000..ae52c838 --- /dev/null +++ b/api/kvision/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/api/kvision/pl.treksoft.kvision.html/-icon/icon.html b/api/kvision/pl.treksoft.kvision.html/-icon/icon.html new file mode 100644 index 00000000..2183247f --- /dev/null +++ b/api/kvision/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/api/kvision/pl.treksoft.kvision.html/-icon/index.html b/api/kvision/pl.treksoft.kvision.html/-icon/index.html new file mode 100644 index 00000000..53bc8b48 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.html/-icon/index.html @@ -0,0 +1,141 @@ + + + +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.

Companion Object Functions

+ + + + + + + +

icon

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

DSL builder extension function.

+ + -- cgit