From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-progress-bar/index.html | 203 +++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/index.html (limited to 'api/pl.treksoft.kvision.progress/-progress-bar/index.html') diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/index.html b/api/pl.treksoft.kvision.progress/-progress-bar/index.html new file mode 100644 index 00000000..c7f47e86 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/index.html @@ -0,0 +1,203 @@ + + + +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.

+
+ + -- cgit