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 --- .../-progress-bar/index.html | 217 +++++++++++++++++++++ 1 file changed, 217 insertions(+) create mode 100644 api1/pl.treksoft.kvision.progress/-progress-bar/index.html (limited to 'api1/pl.treksoft.kvision.progress/-progress-bar/index.html') diff --git a/api1/pl.treksoft.kvision.progress/-progress-bar/index.html b/api1/pl.treksoft.kvision.progress/-progress-bar/index.html new file mode 100644 index 00000000..747f7bdd --- /dev/null +++ b/api1/pl.treksoft.kvision.progress/-progress-bar/index.html @@ -0,0 +1,217 @@ + + + +ProgressBar - kvision + + + +kvision / pl.treksoft.kvision.progress / ProgressBar
+
+

ProgressBar

+open class ProgressBar : SimplePanel +

The Bootstrap progress bar.

Constructors

+ + + + + + + +

<init>

ProgressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (ProgressBar.() -> Unit)? = null)

Properties

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

+ align +	+`var align: Align?` + Text align of the progress bar. +
+ animated +	+`var animated: Boolean` + Determines if the progress bar is animated. +
+ content +	+`var content: String?` + Text content of the progress bar. +
+ max +	+`var max: Int` + The maximal progress. +
+ min +	+`var min: Int` + The minimal progress. +
+ progress +	+`var progress: Int` + The current progress. +
+ rich +	+`var rich: Boolean` + Determines if content can contain HTML code. +
+ striped +	+`var striped: Boolean` + Determines if the progress bar is striped. +
+ style +	+`var style: ProgressBarStyle?` + The style of the progress bar. +

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. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Functions

+ + + + + + + +

progressBar

fun Container.progressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (ProgressBar.() -> Unit)? = null): ProgressBar

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + -- cgit