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/-link/-init-.html | 27 +++ .../-link/get-sn-attrs.html | 18 ++ api1/pl.treksoft.kvision.html/-link/icon.html | 21 +++ api1/pl.treksoft.kvision.html/-link/image.html | 21 +++ api1/pl.treksoft.kvision.html/-link/index.html | 205 +++++++++++++++++++++ api1/pl.treksoft.kvision.html/-link/label.html | 21 +++ .../-link/link-disabled.html | 18 ++ api1/pl.treksoft.kvision.html/-link/link.html | 16 ++ api1/pl.treksoft.kvision.html/-link/on-click.html | 15 ++ api1/pl.treksoft.kvision.html/-link/render.html | 18 ++ api1/pl.treksoft.kvision.html/-link/url.html | 21 +++ 11 files changed, 401 insertions(+) create mode 100644 api1/pl.treksoft.kvision.html/-link/-init-.html create mode 100644 api1/pl.treksoft.kvision.html/-link/get-sn-attrs.html create mode 100644 api1/pl.treksoft.kvision.html/-link/icon.html create mode 100644 api1/pl.treksoft.kvision.html/-link/image.html create mode 100644 api1/pl.treksoft.kvision.html/-link/index.html create mode 100644 api1/pl.treksoft.kvision.html/-link/label.html create mode 100644 api1/pl.treksoft.kvision.html/-link/link-disabled.html create mode 100644 api1/pl.treksoft.kvision.html/-link/link.html create mode 100644 api1/pl.treksoft.kvision.html/-link/on-click.html create mode 100644 api1/pl.treksoft.kvision.html/-link/render.html create mode 100644 api1/pl.treksoft.kvision.html/-link/url.html (limited to 'api1/pl.treksoft.kvision.html/-link') diff --git a/api1/pl.treksoft.kvision.html/-link/-init-.html b/api1/pl.treksoft.kvision.html/-link/-init-.html new file mode 100644 index 00000000..40df5810 --- /dev/null +++ b/api1/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? = null, 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/api1/pl.treksoft.kvision.html/-link/get-sn-attrs.html b/api1/pl.treksoft.kvision.html/-link/get-sn-attrs.html new file mode 100644 index 00000000..2adbd0fe --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.html/-link/icon.html b/api1/pl.treksoft.kvision.html/-link/icon.html new file mode 100644 index 00000000..1dd6cb19 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/icon.html @@ -0,0 +1,21 @@ + + + +Link.icon - kvision + + + +kvision / pl.treksoft.kvision.html / Link / icon
+
+

icon

+ +var icon: String? +

Link icon.

Getter
+

Link icon.

Setter
+

Link icon.

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/image.html b/api1/pl.treksoft.kvision.html/-link/image.html new file mode 100644 index 00000000..2d4687cf --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/image.html @@ -0,0 +1,21 @@ + + + +Link.image - kvision + + + +kvision / pl.treksoft.kvision.html / Link / image
+
+

image

+ +var image: ResString? +

Link image.

Getter
+

Link image.

Setter
+

Link image.

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/index.html b/api1/pl.treksoft.kvision.html/-link/index.html new file mode 100644 index 00000000..9ff080aa --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/index.html @@ -0,0 +1,205 @@ + + + +Link - kvision + + + +kvision / pl.treksoft.kvision.html / Link
+
+

Link

+open class Link : SimplePanel +

Link component.

Constructors

+ + + + + + + +

<init>

Link(label: String, url: String? = null, 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. +
+ onClick +	+`open fun onClick(handler: Link.(MouseEvent) -> Unit): Link` + A convenient helper for easy setting onClick event handler. +
+ 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. +

Companion Object Functions

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

+ link +	+`fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link` + DSL builder extension function. +
+ linkDisabled +	+`fun ListTag.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link` +`fun DropDown.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link` + DSL builder extension function for a disabled link in a dropdown list. +

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/label.html b/api1/pl.treksoft.kvision.html/-link/label.html new file mode 100644 index 00000000..2210e2d1 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/label.html @@ -0,0 +1,21 @@ + + + +Link.label - kvision + + + +kvision / pl.treksoft.kvision.html / Link / label
+
+

label

+ +var label: String +

Link label.

Getter
+

Link label.

Setter
+

Link label.

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/link-disabled.html b/api1/pl.treksoft.kvision.html/-link/link-disabled.html new file mode 100644 index 00000000..4c3ffe22 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/link-disabled.html @@ -0,0 +1,18 @@ + + + +Link.linkDisabled - kvision + + + +kvision / pl.treksoft.kvision.html / Link / linkDisabled
+
+

linkDisabled

+ +

fun ListTag.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link

+ +

fun DropDown.linkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link

DSL builder extension function for a disabled link in a dropdown list.

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

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/link.html b/api1/pl.treksoft.kvision.html/-link/link.html new file mode 100644 index 00000000..9ebd545f --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/link.html @@ -0,0 +1,16 @@ + + + +Link.link - kvision + + + +kvision / pl.treksoft.kvision.html / Link / link
+
+

link

+ +

fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/on-click.html b/api1/pl.treksoft.kvision.html/-link/on-click.html new file mode 100644 index 00000000..ca274fbf --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/on-click.html @@ -0,0 +1,15 @@ + + + +Link.onClick - kvision + + + +kvision / pl.treksoft.kvision.html / Link / onClick
+
+

onClick

+ +open fun onClick(handler: Link.(MouseEvent) -> Unit): Link +

A convenient helper for easy setting onClick event handler.

+ + diff --git a/api1/pl.treksoft.kvision.html/-link/render.html b/api1/pl.treksoft.kvision.html/-link/render.html new file mode 100644 index 00000000..295bfb6f --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.html/-link/url.html b/api1/pl.treksoft.kvision.html/-link/url.html new file mode 100644 index 00000000..dd509277 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-link/url.html @@ -0,0 +1,21 @@ + + + +Link.url - kvision + + + +kvision / pl.treksoft.kvision.html / Link / url
+
+

url

+ +var url: String? +

Link URL address.

Getter
+

Link URL address.

Setter
+

Link URL address.

+ + -- cgit