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.panel/-root/-init-.html | 16 +- .../-root/add-context-menu.html | 14 + api/pl.treksoft.kvision.panel/-root/index.html | 784 ++++++++++++++++++++- 3 files changed, 811 insertions(+), 3 deletions(-) create mode 100644 api/pl.treksoft.kvision.panel/-root/add-context-menu.html (limited to 'api/pl.treksoft.kvision.panel/-root') diff --git a/api/pl.treksoft.kvision.panel/-root/-init-.html b/api/pl.treksoft.kvision.panel/-root/-init-.html index 783c11cd..4369a710 100644 --- a/api/pl.treksoft.kvision.panel/-root/-init-.html +++ b/api/pl.treksoft.kvision.panel/-root/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.panel / Root / <init>

<init>

- -

Root(id: String? = null, element: <ERROR CLASS>? = null, fixed: Boolean = false, init: (Root.() -> Unit)? = null)

+ +Root(id: String, fixed: Boolean = false, init: (Root.() -> Unit)? = null)

Parameters

id - ID attribute of element in the main HTML file

@@ -20,5 +20,17 @@ otherwise it's rendered with "container" class (default is false)

init - an initializer extension function

Constructor

+ +Root(element: <ERROR CLASS>, fixed: Boolean = false, init: (Root.() -> Unit)? = null) +

Parameters

+element - HTML element in the DOM tree

+fixed - if false, the container is rendered with Bootstrap "container-fluid" class, +otherwise it's rendered with "container" class (default is false)

+init - an initializer extension function

Constructor
+

diff --git a/api/pl.treksoft.kvision.panel/-root/add-context-menu.html b/api/pl.treksoft.kvision.panel/-root/add-context-menu.html new file mode 100644 index 00000000..16ba6af6 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-root/add-context-menu.html @@ -0,0 +1,14 @@ + + + +Root.addContextMenu - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / addContextMenu
+
+

addContextMenu

+ +fun addContextMenu(contextMenu: Widget): Unit + + diff --git a/api/pl.treksoft.kvision.panel/-root/index.html b/api/pl.treksoft.kvision.panel/-root/index.html index 99089a94..2b43dd6e 100644 --- a/api/pl.treksoft.kvision.panel/-root/index.html +++ b/api/pl.treksoft.kvision.panel/-root/index.html @@ -21,7 +21,8 @@ Snabbdom virtual DOM.

<init>

Root(id: String? = null, element: <ERROR CLASS>? = null, fixed: Boolean = false, init: (Root.() -> Unit)? = null)

+Root(id: String, fixed: Boolean = false, init: (Root.() -> Unit)? = null)
+Root(element: <ERROR CLASS>, fixed: Boolean = false, init: (Root.() -> Unit)? = null) @@ -37,11 +38,30 @@ Snabbdom virtual DOM.

Inherited Properties

+ + + + + + + +

children

+val children: MutableList<Component>

Functions

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

+ addContextMenu +	+`fun addContextMenu(contextMenu: Widget): Unit`
getRoot	@@ -140,6 +160,113 @@ Snabbdom virtual DOM.
+ addBsBgColor +	+`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
+ addBsBorder +	+`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
+ addBsClearfix +	+`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. +
createInstance	@@ -147,6 +274,661 @@ Snabbdom virtual DOM. 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: (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,`