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 --- api/pl.treksoft.kvision.navbar/-nav/index.html | 794 +++++++++++++++++++++++-- 1 file changed, 740 insertions(+), 54 deletions(-) (limited to 'api/pl.treksoft.kvision.navbar/-nav/index.html') diff --git a/api/pl.treksoft.kvision.navbar/-nav/index.html b/api/pl.treksoft.kvision.navbar/-nav/index.html index 33f7eebf..472c7320 100644 --- a/api/pl.treksoft.kvision.navbar/-nav/index.html +++ b/api/pl.treksoft.kvision.navbar/-nav/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.navbar / Nav

Nav

-open class Nav : Tag +open class Nav : Div

The Bootstrap Nav container.

Constructors

@@ -36,117 +36,130 @@
-

Inherited Properties

+

Functions

+ + + +
-

align

+

getSnClass

+		 +open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

+

Extension Functions

+ + + + + + + + + + + + - -
-var align: Align? -

Text align.

+

addBsBgColor

 +fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit
-

content

+

addBsBorder

 -open var content: String? -

Text content of the tag.

+fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit
+

addBsClearfix

 +fun Component.addBsClearfix(): Unit
-

rich

+

addBsColor

 -open var rich: Boolean -

Determines if content can contain HTML code.

+fun Component.addBsColor(bsColor: BsColor): Unit
+

addBsRounded

 +fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit
-

template

+

bold

 -open var template: ((Any?) -> String)? -

Handlebars template.

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

DSL builder extension function.
-

templates

+

button

 -open var templates: Map<String, (Any?) -> String> -

Handlebars templates for i18n.

+fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button +

DSL builder extension function.
-

type

+

buttonGroup

 -var type: TAG -

Tag type.

+fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup +

DSL builder extension function.
-

Functions

- - - -
-

getSnClass

+

canvas

 -open fun getSnClass(): List<StringBoolPair> -

Returns list of CSS class names for current widget in the form of a List.

+fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas +

DSL builder extension function.
-

Inherited Functions

- - +fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: (CheckBox.() -> Unit)? = null): CheckBox +

DSL builder extension function.

+ - -
-

render

+

chart

 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

+fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: (Chart.() -> Unit)? = null): Chart +

DSL builder extension function.
-

unaryPlus

+

checkBox

 -operator fun String.unaryPlus(): Unit
-

Companion Object Functions

- - + + + + - -
-

nav

+

checkBoxInput

 -fun Navbar.nav(rightAlign: Boolean = false, classes: Set<String> = setOf(), init: (Nav.() -> Unit)? = null): Nav +fun Container.checkBoxInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): CheckBoxInput +

DSL builder extension function.

+
+

contextMenu

+		 +fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu

DSL builder extension function.
-

Extension Functions

- -

createInstance

@@ -158,12 +171,685 @@
-

setData

+

dataContainer

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

+fun <M, C : Component, CONT : Container> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, CONT>.() -> Unit)? = null): DataContainer<M, C, CONT> +

DSL builder extension function.

+fun <M, C : Component> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, containerAdd: (VPanel.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null,