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/-navbar/-init-.html | 12 +- .../-navbar/bg-color.html | 21 + api/pl.treksoft.kvision.navbar/-navbar/expand.html | 21 + api/pl.treksoft.kvision.navbar/-navbar/index.html | 827 ++++++++++++++++++++- .../-navbar/inverted.html | 21 - .../-navbar/n-color.html | 21 + api/pl.treksoft.kvision.navbar/-navbar/navbar.html | 16 - 7 files changed, 886 insertions(+), 53 deletions(-) create mode 100644 api/pl.treksoft.kvision.navbar/-navbar/bg-color.html create mode 100644 api/pl.treksoft.kvision.navbar/-navbar/expand.html delete mode 100644 api/pl.treksoft.kvision.navbar/-navbar/inverted.html create mode 100644 api/pl.treksoft.kvision.navbar/-navbar/n-color.html delete mode 100644 api/pl.treksoft.kvision.navbar/-navbar/navbar.html (limited to 'api/pl.treksoft.kvision.navbar/-navbar') diff --git a/api/pl.treksoft.kvision.navbar/-navbar/-init-.html b/api/pl.treksoft.kvision.navbar/-navbar/-init-.html index 41b55304..940a76db 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/-init-.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/-init-.html @@ -8,15 +8,19 @@ kvision / pl.treksoft.kvision.navbar / Navbar / <init>

<init>

- -

Navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null)

+ +

Navbar(label: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null)

Parameters

label - the navbar label

type - the navbar type

-inverted - determines if the navbar is inverted

+expand - the navbar responsive behavior

+nColor - the navbar color

+bgColor - the navbar background color

classes - a set of CSS class names

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html b/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html new file mode 100644 index 00000000..f3c5e42b --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-navbar/bg-color.html @@ -0,0 +1,21 @@ + + + +Navbar.bgColor - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / bgColor
+
+

bgColor

+ +var bgColor: BsBgColor +

The navbar background color.

Getter
+

The navbar background color.

Setter
+

The navbar background color.

+ + diff --git a/api/pl.treksoft.kvision.navbar/-navbar/expand.html b/api/pl.treksoft.kvision.navbar/-navbar/expand.html new file mode 100644 index 00000000..03621867 --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-navbar/expand.html @@ -0,0 +1,21 @@ + + + +Navbar.expand - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / expand
+
+

expand

+ +var expand: NavbarExpand? +

The navbar responsive behavior.

Getter
+

The navbar responsive behavior.

Setter
+

The navbar responsive behavior.

+ + diff --git a/api/pl.treksoft.kvision.navbar/-navbar/index.html b/api/pl.treksoft.kvision.navbar/-navbar/index.html index 6bd615f6..e426c87c 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/index.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/index.html @@ -18,7 +18,7 @@

<init>

Navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null)

Navbar(label: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null)

@@ -27,11 +27,20 @@ -

inverted

bgColor

-var inverted: Boolean -

Determines if the navbar is inverted.

+var bgColor: BsBgColor +

The navbar background color.

+ + + + +

expand

+ + +var expand: NavbarExpand? +

The navbar responsive behavior.

@@ -45,6 +54,15 @@ +

nColor

+ + +var nColor: NavbarColor +

The navbar color.

+ + + +

type

@@ -54,6 +72,18 @@ +

Inherited Properties

+ + + + + + + +

children

+val children: MutableList<Component>

Functions

@@ -145,23 +175,116 @@

Companion Object Functions

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -

- navbar + addBsBgColor +	+`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
+ addBsBorder +	+`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
+ addBsClearfix	-`fun Container.navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null): Navbar` +`fun Component.addBsClearfix(): Unit`
+ addBsColor +	+`fun Component.addBsColor(bsColor: BsColor): Unit`
+ addBsRounded +	+`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
+ bold +	+`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. +
+ button +	+`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. +
+ buttonGroup +	+`fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup` + DSL builder extension function. +
+ canvas +	+`fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas` + DSL builder extension function. +
+ chart +	+`fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: (Chart.() -> Unit)? = null): Chart` + DSL builder extension function. +
+ checkBox +	+`fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: (CheckBox.() -> Unit)? = null): CheckBox` + DSL builder extension function. +
+ checkBoxInput +	+`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

@@ -171,6 +294,686 @@

Helper function for creating JavaScript objects from dynamic constructors.

dataContainer

fun <M, C : Component, CONT : Container> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (