From bfd5aa358e141d6c86d476d8bb66b104a80a3b96 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 21 May 2020 00:13:50 +0200 Subject: API documentation for KVision 3.10.0 --- .../-text-node/-init-.html | 23 ++ .../-text-node/content.html | 21 ++ api/pl.treksoft.kvision.html/-text-node/index.html | 244 +++++++++++++++++++++ .../-text-node/render.html | 17 ++ api/pl.treksoft.kvision.html/-text-node/rich.html | 21 ++ 5 files changed, 326 insertions(+) create mode 100644 api/pl.treksoft.kvision.html/-text-node/-init-.html create mode 100644 api/pl.treksoft.kvision.html/-text-node/content.html create mode 100644 api/pl.treksoft.kvision.html/-text-node/index.html create mode 100644 api/pl.treksoft.kvision.html/-text-node/render.html create mode 100644 api/pl.treksoft.kvision.html/-text-node/rich.html (limited to 'api/pl.treksoft.kvision.html/-text-node') diff --git a/api/pl.treksoft.kvision.html/-text-node/-init-.html b/api/pl.treksoft.kvision.html/-text-node/-init-.html new file mode 100644 index 00000000..62b1844d --- /dev/null +++ b/api/pl.treksoft.kvision.html/-text-node/-init-.html @@ -0,0 +1,23 @@ + + + +TextNode.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / TextNode / <init>
+
+

<init>

+(js) +TextNode(content: String, rich: Boolean = false, init: (TextNode.() -> Unit)? = null) +

Parameters

+content - node text

+rich - determines if content can contain HTML code

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.html/-text-node/content.html b/api/pl.treksoft.kvision.html/-text-node/content.html new file mode 100644 index 00000000..d155715b --- /dev/null +++ b/api/pl.treksoft.kvision.html/-text-node/content.html @@ -0,0 +1,21 @@ + + + +TextNode.content - kvision + + + +kvision / pl.treksoft.kvision.html / TextNode / content
+
+

content

+(js) +var content: String +

Text content of the tag.

Getter
+

Text content of the tag.

Setter
+

Text content of the tag.

+ + diff --git a/api/pl.treksoft.kvision.html/-text-node/index.html b/api/pl.treksoft.kvision.html/-text-node/index.html new file mode 100644 index 00000000..0c3a0bf4 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-text-node/index.html @@ -0,0 +1,244 @@ + + + +TextNode - kvision + + + +kvision / pl.treksoft.kvision.html / TextNode
+
+

TextNode

+(js) open class TextNode : Widget +

Simple component for rendering text DOM node.

Constructors

+ + + + + + + +

+(js) +

<init>

+TextNode(content: String, rich: Boolean = false, init: (TextNode.() -> Unit)? = null)

Properties

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

+(js) + content +	+ Text content of the tag. +`var content: String`
+(js) + rich +	+ Determines if content can contain HTML code. +`var rich: Boolean`

Functions

+ + + + + + + +

+(js) +

render

Renders current component as a Snabbdom vnode.

+open fun render(): VNode

Extension Properties

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

+(js) + changeFlow +	+ Extension property returning Flow for a change event. +`val <T : Widget> T.changeFlow: Flow<T>`
+(js) + clickFlow +	+ Extension property returning Flow for a click event. +`val <T : Widget> T.clickFlow: Flow<T>`
+(js) + inputFlow +	+ Extension property returning Flow for an input event. +`val <T : Widget> T.inputFlow: Flow<T>`

Extension Functions

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

+(js) + addBsBgColor +	+`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
+(js) + addBsBorder +	+`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
+(js) + addBsClearfix +	+`fun Component.addBsClearfix(): Unit`
+(js) + addBsColor +	+`fun Component.addBsColor(bsColor: BsColor): Unit`
+(js) + addBsRounded +	+`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
+(js) + bind +	+ An extension function which binds the widget to the observable state. +`fun <S, W : Widget> W.bind(observableState: ObservableState<S>, factory: W.(S) -> Unit): W`
+(js) + contextMenu +	+ DSL builder extension function. +`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String>? = null, className: String? = null, init: (ContextMenu.() -> Unit)? = null): ContextMenu`
+(js) + eventFlow +	+ Extension property returning Flow<Pair<Widget, Event>> for a given event +`fun <T : Widget> T.eventFlow(event: String): Flow<Pair<T, Event>>`
+(js) + onClick +	+ An extension function for defining on click event handlers. +`fun <T : Widget> T.onClick(handler: T.(MouseEvent) -> Unit): Int`
+(js) + onEvent +	+ An extension function for defining event handlers. +`fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Int`
+(js) + removeBsBgColor +	+`fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit`
+(js) + removeBsBorder +	+`fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit`
+(js) + removeBsClearfix +	+`fun Component.removeBsClearfix(): Unit`
+(js) + removeBsColor +	+`fun Component.removeBsColor(bsColor: BsColor): Unit`
+(js) + removeBsRounded +	+`fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit`
+(js) + setContextMenu +	+ Sets context menu for the current widget. +`fun Widget.setContextMenu(contextMenu: ContextMenu): Widget`
+(js) + style +	+ DSL builder extension function. +`fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style`

+ + diff --git a/api/pl.treksoft.kvision.html/-text-node/render.html b/api/pl.treksoft.kvision.html/-text-node/render.html new file mode 100644 index 00000000..0fb2eada --- /dev/null +++ b/api/pl.treksoft.kvision.html/-text-node/render.html @@ -0,0 +1,17 @@ + + + +TextNode.render - kvision + + + +kvision / pl.treksoft.kvision.html / TextNode / render
+
+

render

+(js) +protected open fun render(): VNode +

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api/pl.treksoft.kvision.html/-text-node/rich.html b/api/pl.treksoft.kvision.html/-text-node/rich.html new file mode 100644 index 00000000..dde4116c --- /dev/null +++ b/api/pl.treksoft.kvision.html/-text-node/rich.html @@ -0,0 +1,21 @@ + + + +TextNode.rich - kvision + + + +kvision / pl.treksoft.kvision.html / TextNode / rich
+
+

rich

+(js) +var rich: Boolean +

Determines if content can contain HTML code.

Getter
+

Determines if content can contain HTML code.

Setter
+

Determines if content can contain HTML code.

+ + -- cgit