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/-footer/-init-.html | 27 ++++ api1/pl.treksoft.kvision.html/-footer/footer.html | 16 +++ api1/pl.treksoft.kvision.html/-footer/index.html | 153 ++++++++++++++++++++++ 3 files changed, 196 insertions(+) create mode 100644 api1/pl.treksoft.kvision.html/-footer/-init-.html create mode 100644 api1/pl.treksoft.kvision.html/-footer/footer.html create mode 100644 api1/pl.treksoft.kvision.html/-footer/index.html (limited to 'api1/pl.treksoft.kvision.html/-footer') diff --git a/api1/pl.treksoft.kvision.html/-footer/-init-.html b/api1/pl.treksoft.kvision.html/-footer/-init-.html new file mode 100644 index 00000000..9db91195 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-footer/-init-.html @@ -0,0 +1,27 @@ + + + +Footer.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / Footer / <init>
+
+

<init>

+ +

Footer(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Footer.() -> Unit)? = null)

Parameters

+content - element text

+rich - determines if content can contain HTML code

+align - content align

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.html/-footer/footer.html b/api1/pl.treksoft.kvision.html/-footer/footer.html new file mode 100644 index 00000000..38a80976 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-footer/footer.html @@ -0,0 +1,16 @@ + + + +Footer.footer - kvision + + + +kvision / pl.treksoft.kvision.html / Footer / footer
+
+

footer

+ +

fun Container.footer(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Footer.() -> Unit)? = null): Footer

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.html/-footer/index.html b/api1/pl.treksoft.kvision.html/-footer/index.html new file mode 100644 index 00000000..60d8029c --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-footer/index.html @@ -0,0 +1,153 @@ + + + +Footer - kvision + + + +kvision / pl.treksoft.kvision.html / Footer
+
+

Footer

+open class Footer : Tag +

Simple component rendered as footer.

Constructors

+ + + + + + + +

<init>

Footer(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Footer.() -> Unit)? = null)

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. +

Inherited Functions

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

+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ unaryPlus +	+`operator fun String.unaryPlus(): Unit`

Companion Object Functions

+ + + + + + + +

footer

fun Container.footer(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Footer.() -> Unit)? = null): Footer

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