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 --- .../api/pl.treksoft.kvision.html/-link/-init-.html | 27 ++++ .../-link/get-sn-attrs.html | 18 +++ docs/api/pl.treksoft.kvision.html/-link/icon.html | 15 ++ docs/api/pl.treksoft.kvision.html/-link/image.html | 15 ++ docs/api/pl.treksoft.kvision.html/-link/index.html | 158 +++++++++++++++++++++ docs/api/pl.treksoft.kvision.html/-link/label.html | 15 ++ .../api/pl.treksoft.kvision.html/-link/render.html | 18 +++ docs/api/pl.treksoft.kvision.html/-link/url.html | 15 ++ 8 files changed, 281 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.html/-link/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/icon.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/image.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/index.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/label.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/render.html create mode 100644 docs/api/pl.treksoft.kvision.html/-link/url.html (limited to 'docs/api/pl.treksoft.kvision.html/-link') diff --git a/docs/api/pl.treksoft.kvision.html/-link/-init-.html b/docs/api/pl.treksoft.kvision.html/-link/-init-.html new file mode 100644 index 00000000..25d0fc1e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/-init-.html @@ -0,0 +1,27 @@ + + + +Link.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / Link / <init>
+
+

<init>

+ +

Link(label: String, url: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf())

Parameters

+label - link label

+url - link URL address

+icon - link icon

+image - link image

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html new file mode 100644 index 00000000..2adbd0fe --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +Link.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.html / Link / 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.html/-link/icon.html b/docs/api/pl.treksoft.kvision.html/-link/icon.html new file mode 100644 index 00000000..e566b959 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/icon.html @@ -0,0 +1,15 @@ + + + +Link.icon - kvision + + + +kvision / pl.treksoft.kvision.html / Link / icon
+
+

icon

+ +var icon: String? +

Link icon.

+ + diff --git a/docs/api/pl.treksoft.kvision.html/-link/image.html b/docs/api/pl.treksoft.kvision.html/-link/image.html new file mode 100644 index 00000000..81612fb2 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/image.html @@ -0,0 +1,15 @@ + + + +Link.image - kvision + + + +kvision / pl.treksoft.kvision.html / Link / image
+
+

image

+ +var image: ResString? +

Link image.

+ + diff --git a/docs/api/pl.treksoft.kvision.html/-link/index.html b/docs/api/pl.treksoft.kvision.html/-link/index.html new file mode 100644 index 00000000..427355c4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/index.html @@ -0,0 +1,158 @@ + + + +Link - kvision + + + +kvision / pl.treksoft.kvision.html / Link
+
+

Link

+open class Link : SimplePanel +

Link component.

Constructors

+ + + + + + + +

<init>

Link(label: String, url: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf())

Properties

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

+ icon +	+`var icon: String?` + Link icon. +
+ image +	+`var image: ResString?` + Link image. +
+ label +	+`var label: String` + Link label. +
+ url +	+`var url: String` + Link URL address. +

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

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

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): SimplePanel` + Removes all children from the current container. +

+ + diff --git a/docs/api/pl.treksoft.kvision.html/-link/label.html b/docs/api/pl.treksoft.kvision.html/-link/label.html new file mode 100644 index 00000000..7774a8d4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/label.html @@ -0,0 +1,15 @@ + + + +Link.label - kvision + + + +kvision / pl.treksoft.kvision.html / Link / label
+
+

label

+ +var label: String +

Link label.

+ + diff --git a/docs/api/pl.treksoft.kvision.html/-link/render.html b/docs/api/pl.treksoft.kvision.html/-link/render.html new file mode 100644 index 00000000..295bfb6f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/render.html @@ -0,0 +1,18 @@ + + + +Link.render - kvision + + + +kvision / pl.treksoft.kvision.html / Link / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/docs/api/pl.treksoft.kvision.html/-link/url.html b/docs/api/pl.treksoft.kvision.html/-link/url.html new file mode 100644 index 00000000..adb256d3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.html/-link/url.html @@ -0,0 +1,15 @@ + + + +Link.url - kvision + + + +kvision / pl.treksoft.kvision.html / Link / url
+
+

url

+ +var url: String +

Link URL address.

+ + -- cgit