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 --- .../-drop-down/-init-.html | 10 +- .../-drop-down/direction.html | 21 + .../-drop-down/drop-down.html | 16 - .../-drop-down/dropup.html | 21 - .../-drop-down/for-drop-down.html | 15 + .../-drop-down/index.html | 847 ++++++++++++++++++++- .../-drop-down/render.html | 18 - 7 files changed, 868 insertions(+), 80 deletions(-) create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/direction.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/render.html (limited to 'api/pl.treksoft.kvision.dropdown/-drop-down') diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html index 67e3cdef..b888b053 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / <init>

<init>

- -

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf())

+ +

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, classes: Set<String> = setOf())

Parameters

text - the label of the dropdown button

@@ -19,12 +19,14 @@ icon - the icon of the dropdown button

style - the style of the dropdown button

+direction - the direction of the dropdown

disabled - determines if the component is disabled on start

forNavbar - determines if the component will be used in a navbar

-withCaret - determines if the dropdown button renders caret

+forDropDown - determines if the component will be used in a dropdown

classes - a set of CSS class names

Constructor
diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html b/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html new file mode 100644 index 00000000..f60fc025 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/direction.html @@ -0,0 +1,21 @@ + + + +DropDown.direction - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / direction
+
+

direction

+ +var direction: Direction +

The direction of the dropdown.

Getter
+

The direction of the dropdown.

Setter
+

The direction of the dropdown.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html deleted file mode 100644 index 8c8fddaa..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DropDown.dropDown - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / dropDown
-
-

dropDown

- -

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: (DropDown.() -> Unit)? = null): DropDown

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html b/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html deleted file mode 100644 index 40a56d7b..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -DropDown.dropup - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / dropup
-
-

dropup

- -var dropup: Boolean -

Determines if the dropdown is showing upwards.

Getter
-

Determines if the dropdown is showing upwards.

Setter
-

Determines if the dropdown is showing upwards.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html new file mode 100644 index 00000000..5e5e2bfc --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/for-drop-down.html @@ -0,0 +1,15 @@ + + + +DropDown.forDropDown - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / forDropDown
+
+

forDropDown

+ +val forDropDown: Boolean +

determines if the component will be used in a dropdown

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html index 245bb51f..b08471fd 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -18,7 +18,7 @@

<init>

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf())

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, classes: Set<String> = setOf())

@@ -36,6 +36,15 @@ +

direction

+ + +var direction: Direction +

The direction of the dropdown.

+ + + +

disabled

@@ -45,11 +54,11 @@ -

dropup

forDropDown

-var dropup: Boolean -

Determines if the dropdown is showing upwards.

+val forDropDown: Boolean +

determines if the component will be used in a dropdown

@@ -117,6 +126,18 @@ +

Inherited Properties

+ + + + + + + +

children

+val children: MutableList<Component>

Functions

@@ -192,15 +213,6 @@ - - - - - -

- render -	-`open fun render(): VNode` - Renders current component as a Snabbdom vnode. -
toggle	@@ -231,18 +243,13 @@ Returns the array of the children Snabbdom vnodes.

Companion Object Functions

- - @@ -252,6 +259,113 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

- dropDown + render	-`fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: (DropDown.() -> Unit)? = null): DropDown` - DSL builder extension function. +`open fun render(): VNode` + Renders current component as a Snabbdom vnode.
+ 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.(`