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 --- .../-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html | 14 ++ .../-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html | 14 ++ .../-context-menu/-init-.html | 23 ++ .../-context-menu/context-menu.html | 16 ++ .../-context-menu/fixed-position.html | 15 ++ .../-context-menu/index.html | 165 +++++++++++++ .../-context-menu/position-menu.html | 20 ++ .../-d-d/-d-i-s-a-b-l-e-d.html | 26 ++ .../-d-d/-h-e-a-d-e-r.html | 26 ++ .../-d-d/-s-e-p-a-r-a-t-o-r.html | 26 ++ api1/pl.treksoft.kvision.dropdown/-d-d/index.html | 66 +++++ api1/pl.treksoft.kvision.dropdown/-d-d/option.html | 14 ++ .../-drop-down/-init-.html | 33 +++ .../-drop-down/add-all.html | 21 ++ .../-drop-down/add.html | 21 ++ .../-drop-down/after-insert.html | 16 ++ .../-drop-down/block.html | 15 ++ .../-drop-down/button-id.html | 14 ++ .../-drop-down/disabled.html | 15 ++ .../-drop-down/drop-down.html | 16 ++ .../-drop-down/dropup.html | 21 ++ .../-drop-down/for-navbar.html | 15 ++ .../-drop-down/get-children.html | 18 ++ .../-drop-down/get-sn-class.html | 18 ++ .../-drop-down/icon.html | 15 ++ .../-drop-down/image.html | 15 ++ .../-drop-down/index.html | 265 +++++++++++++++++++++ .../-drop-down/remove-all.html | 18 ++ .../-drop-down/remove.html | 21 ++ .../-drop-down/render.html | 18 ++ .../-drop-down/size.html | 15 ++ .../-drop-down/style.html | 15 ++ .../-drop-down/text.html | 15 ++ .../-drop-down/toggle.html | 15 ++ .../-drop-down/width.html | 16 ++ .../-header/-init-.html | 21 ++ .../-header/header.html | 18 ++ .../-header/index.html | 154 ++++++++++++ .../-separator/-init-.html | 19 ++ .../-separator/index.html | 154 ++++++++++++ .../-separator/separator.html | 18 ++ api1/pl.treksoft.kvision.dropdown/index.html | 63 +++++ 42 files changed, 1523 insertions(+) create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/index.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-d-d/index.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-d-d/option.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/-init-.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/add-all.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/add.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/block.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/button-id.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/disabled.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/dropup.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/get-children.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/icon.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/image.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/index.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/remove.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/render.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/size.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/style.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/text.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/toggle.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-drop-down/width.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-header/-init-.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-header/header.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-header/index.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-separator/-init-.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-separator/index.html create mode 100644 api1/pl.treksoft.kvision.dropdown/-separator/separator.html create mode 100644 api1/pl.treksoft.kvision.dropdown/index.html (limited to 'api1/pl.treksoft.kvision.dropdown') diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html new file mode 100644 index 00000000..afcbe005 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-x.html @@ -0,0 +1,14 @@ + + + +ContextMenu.DEFAULT_FIXED_POS_X - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / DEFAULT_FIXED_POS_X
+
+

DEFAULT_FIXED_POS_X

+ +const val DEFAULT_FIXED_POS_X: Int + + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html new file mode 100644 index 00000000..dd1cf10f --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/-d-e-f-a-u-l-t_-f-i-x-e-d_-p-o-s_-y.html @@ -0,0 +1,14 @@ + + + +ContextMenu.DEFAULT_FIXED_POS_Y - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / DEFAULT_FIXED_POS_Y
+
+

DEFAULT_FIXED_POS_Y

+ +const val DEFAULT_FIXED_POS_Y: Int + + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html new file mode 100644 index 00000000..7fd2c64d --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/-init-.html @@ -0,0 +1,23 @@ + + + +ContextMenu.<init> - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / <init>
+
+

<init>

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

Parameters

+

+element - an element to bind

+

+fixedPosition - use fixed positioning

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html new file mode 100644 index 00000000..409d2e1b --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html @@ -0,0 +1,16 @@ + + + +ContextMenu.contextMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / contextMenu
+
+

contextMenu

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

DSL builder extension function.

+

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

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html new file mode 100644 index 00000000..48564039 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/fixed-position.html @@ -0,0 +1,15 @@ + + + +ContextMenu.fixedPosition - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / fixedPosition
+
+

fixedPosition

+ +protected val fixedPosition: Boolean +

use fixed positioning

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/index.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/index.html new file mode 100644 index 00000000..0f9dc915 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/index.html @@ -0,0 +1,165 @@ + + + +ContextMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu
+
+

ContextMenu

+open class ContextMenu : ListTag +

Context menu component.

+

Constructors

+ + + + + + + +
+

<init>

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

Properties

+ + + + + + + +
+

fixedPosition

+		 +val fixedPosition: Boolean +

use fixed positioning

+
+

Inherited Properties

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

elements

+		 +var elements: List<String>? +

List of elements.

+
+

rich

+		 +var rich: Boolean +

Determines if elements can contain HTML code.

+
+

type

+		 +var type: ListType +

List type.

+
+

Functions

+ + + + + + + +
+

positionMenu

+		 +open fun positionMenu(mouseEvent: MouseEvent): ContextMenu +

Positions and shows a context menu based on a mouse event.

+
+

Inherited Functions

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

childrenVNodes

+		 +open fun childrenVNodes(): Array<VNode> +

Returns the array of the children Snabbdom vnodes.

+
+

getSnClass

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

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

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

Companion Object Properties

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

DEFAULT_FIXED_POS_X

+		 +const val DEFAULT_FIXED_POS_X: Int
+

DEFAULT_FIXED_POS_Y

+		 +const val DEFAULT_FIXED_POS_Y: Int
+

Companion Object Functions

+ + + + + + + +
+

contextMenu

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

DSL builder extension function.

+
+

Extension Functions

+ + + + + + + +
+

createInstance

+		 +fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html b/api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html new file mode 100644 index 00000000..ded70c2c --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html @@ -0,0 +1,20 @@ + + + +ContextMenu.positionMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / positionMenu
+
+

positionMenu

+ +open fun positionMenu(mouseEvent: MouseEvent): ContextMenu +

Positions and shows a context menu based on a mouse event.

+

Parameters

+

+mouseEvent - mouse event

+

Return
+current context menu

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html b/api1/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html new file mode 100644 index 00000000..c5172948 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html @@ -0,0 +1,26 @@ + + + +DD.DISABLED - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / DISABLED
+
+

DISABLED

+ +DISABLED +

Inherited Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html b/api1/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html new file mode 100644 index 00000000..c0521931 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html @@ -0,0 +1,26 @@ + + + +DD.HEADER - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / HEADER
+
+

HEADER

+ +HEADER +

Inherited Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html b/api1/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html new file mode 100644 index 00000000..d518de3c --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html @@ -0,0 +1,26 @@ + + + +DD.SEPARATOR - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / SEPARATOR
+
+

SEPARATOR

+ +SEPARATOR +

Inherited Properties

+ + + + + + + +
+

option

+		 +val option: String
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-d-d/index.html b/api1/pl.treksoft.kvision.dropdown/-d-d/index.html new file mode 100644 index 00000000..06fe5749 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-d-d/index.html @@ -0,0 +1,66 @@ + + + +DD - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD
+
+

DD

+enum class DD +

Useful options for use in DropDown's elements parameter.

+

Enum Values

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

HEADER

+		 +
+

DISABLED

+		 +
+

SEPARATOR

+		 +
+

Properties

+ + + + + + + +
+

option

+		 +val option: String
+

Extension Functions

+ + + + + + + +
+

createInstance

+		 +fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-d-d/option.html b/api1/pl.treksoft.kvision.dropdown/-d-d/option.html new file mode 100644 index 00000000..518c5aed --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-d-d/option.html @@ -0,0 +1,14 @@ + + + +DD.option - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DD / option
+
+

option

+ +val option: String + + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/-init-.html new file mode 100644 index 00000000..67e3cdef --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -0,0 +1,33 @@ + + + +DropDown.<init> - kvision + + + +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()) +

Parameters

+

+text - the label of the dropdown button

+

+elements - an optional list of link elements (special options from DD enum class can be used as values)

+

+icon - the icon of the dropdown button

+

+style - the style of the dropdown button

+

+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

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/add-all.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/add-all.html new file mode 100644 index 00000000..464a2fea --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/add-all.html @@ -0,0 +1,21 @@ + + + +DropDown.addAll - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / addAll
+
+

addAll

+ +open fun addAll(children: List<Component>): SimplePanel +

Overrides SimplePanel.addAll

+

Adds a list of components to the current container.

+

Parameters

+

+children - list of child components

+

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/add.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/add.html new file mode 100644 index 00000000..85081d14 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/add.html @@ -0,0 +1,21 @@ + + + +DropDown.add - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / add
+
+

add

+ +open fun add(child: Component): SimplePanel +

Overrides SimplePanel.add

+

Adds given component to the current container.

+

Parameters

+

+child - child component

+

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html new file mode 100644 index 00000000..1b4bb89d --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html @@ -0,0 +1,16 @@ + + + +DropDown.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / afterInsert
+
+

afterInsert

+ +protected open fun afterInsert(node: VNode): Unit +

Overrides Widget.afterInsert

+

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/block.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/block.html new file mode 100644 index 00000000..446d4803 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/block.html @@ -0,0 +1,15 @@ + + + +DropDown.block - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / block
+
+

block

+ +var block: Boolean +

Determines if the dropdown button takes all the space horizontally.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/button-id.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/button-id.html new file mode 100644 index 00000000..abac1ea0 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/button-id.html @@ -0,0 +1,14 @@ + + + +DropDown.buttonId - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / buttonId
+
+

buttonId

+ +fun buttonId(): String? + + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/disabled.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/disabled.html new file mode 100644 index 00000000..9c25d116 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/disabled.html @@ -0,0 +1,15 @@ + + + +DropDown.disabled - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if the dropdown is disabled.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html new file mode 100644 index 00000000..8c8fddaa --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html @@ -0,0 +1,16 @@ + + + +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/api1/pl.treksoft.kvision.dropdown/-drop-down/dropup.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/dropup.html new file mode 100644 index 00000000..40a56d7b --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/dropup.html @@ -0,0 +1,21 @@ + + + +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/api1/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html new file mode 100644 index 00000000..33497640 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html @@ -0,0 +1,15 @@ + + + +DropDown.forNavbar - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / forNavbar
+
+

forNavbar

+ +val forNavbar: Boolean +

determines if the component will be used in a navbar

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/get-children.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/get-children.html new file mode 100644 index 00000000..749b4086 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/get-children.html @@ -0,0 +1,18 @@ + + + +DropDown.getChildren - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / getChildren
+
+

getChildren

+ +open fun getChildren(): List<Component> +

Overrides SimplePanel.getChildren

+

Returns a list of children of the current container.

+

Return
+list of children

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html new file mode 100644 index 00000000..c9d8031d --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html @@ -0,0 +1,18 @@ + + + +DropDown.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / getSnClass
+
+

getSnClass

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

Overrides Widget.getSnClass

+

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

+

Return
+list of CSS class names

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/icon.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/icon.html new file mode 100644 index 00000000..33c4950b --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/icon.html @@ -0,0 +1,15 @@ + + + +DropDown.icon - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / icon
+
+

icon

+ +var icon: String? +

The icon of the dropdown button.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/image.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/image.html new file mode 100644 index 00000000..56755e67 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/image.html @@ -0,0 +1,15 @@ + + + +DropDown.image - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / image
+
+

image

+ +var image: ResString? +

The image on the dropdown button.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/index.html new file mode 100644 index 00000000..245bb51f --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -0,0 +1,265 @@ + + + +DropDown - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown
+
+

DropDown

+open class DropDown : SimplePanel +

Bootstrap dropdown component.

+

Constructors

+ + + + + + + +
+

<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())
+

Properties

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

block

+		 +var block: Boolean +

Determines if the dropdown button takes all the space horizontally.

+
+

disabled

+		 +var disabled: Boolean +

Determines if the dropdown is disabled.

+
+

dropup

+		 +var dropup: Boolean +

Determines if the dropdown is showing upwards.

+
+

forNavbar

+		 +val forNavbar: Boolean +

determines if the component will be used in a navbar

+
+

icon

+		 +var icon: String? +

The icon of the dropdown button.

+
+

image

+		 +var image: ResString? +

The image on the dropdown button.

+
+

size

+		 +var size: ButtonSize? +

The size of the dropdown button.

+
+

style

+		 +var style: ButtonStyle +

The style of the dropdown button.

+
+

text

+		 +var text: String +

Label of the dropdown button.

+
+

width

+		 +open var width: CssSize? +

Width of the dropdown button.

+
+

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.

+
+

afterInsert

+		 +open fun afterInsert(node: VNode): Unit +

Method called after inserting Snabbdom vnode into the DOM.

+
+

buttonId

+		 +fun buttonId(): String?
+

getChildren

+		 +open fun getChildren(): List<Component> +

Returns a list of children of the current container.

+
+

getSnClass

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

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

+
+

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.

+
+

toggle

+		 +open fun toggle(): Unit +

Toggles dropdown visibility.

+
+

Inherited Functions

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

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.

+
+

Companion Object Functions

+ + + + + + + +
+

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.

+
+

Extension Functions

+ + + + + + + +
+

createInstance

+		 +fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html new file mode 100644 index 00000000..e90b5611 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html @@ -0,0 +1,18 @@ + + + +DropDown.removeAll - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

+

Removes all children from the current container.

+

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/remove.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/remove.html new file mode 100644 index 00000000..8b80a74c --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/remove.html @@ -0,0 +1,21 @@ + + + +DropDown.remove - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / remove
+
+

remove

+ +open fun remove(child: Component): SimplePanel +

Overrides SimplePanel.remove

+

Removes given component from the current container.

+

Parameters

+

+child - child component

+

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/render.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/render.html new file mode 100644 index 00000000..6f4b3a6b --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/render.html @@ -0,0 +1,18 @@ + + + +DropDown.render - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

+

Renders current component as a Snabbdom vnode.

+

Return
+Snabbdom vnode

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/size.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/size.html new file mode 100644 index 00000000..e29a3169 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/size.html @@ -0,0 +1,15 @@ + + + +DropDown.size - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / size
+
+

size

+ +var size: ButtonSize? +

The size of the dropdown button.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/style.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/style.html new file mode 100644 index 00000000..15e06226 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/style.html @@ -0,0 +1,15 @@ + + + +DropDown.style - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / style
+
+

style

+ +var style: ButtonStyle +

The style of the dropdown button.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/text.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/text.html new file mode 100644 index 00000000..48000a63 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/text.html @@ -0,0 +1,15 @@ + + + +DropDown.text - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / text
+
+

text

+ +var text: String +

Label of the dropdown button.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/toggle.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/toggle.html new file mode 100644 index 00000000..3c4ee0be --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/toggle.html @@ -0,0 +1,15 @@ + + + +DropDown.toggle - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / toggle
+
+

toggle

+ +open fun toggle(): Unit +

Toggles dropdown visibility.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-drop-down/width.html b/api1/pl.treksoft.kvision.dropdown/-drop-down/width.html new file mode 100644 index 00000000..e49c85c0 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-drop-down/width.html @@ -0,0 +1,16 @@ + + + +DropDown.width - kvision + + + +kvision / pl.treksoft.kvision.dropdown / DropDown / width
+
+

width

+ +open var width: CssSize? +

Overrides StyledComponent.width

+

Width of the dropdown button.

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-header/-init-.html b/api1/pl.treksoft.kvision.dropdown/-header/-init-.html new file mode 100644 index 00000000..3d47ac09 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-header/-init-.html @@ -0,0 +1,21 @@ + + + +Header.<init> - kvision + + + +kvision / pl.treksoft.kvision.dropdown / Header / <init>
+
+

<init>

+ +Header(content: String? = null, classes: Set<String> = setOf()) +

Parameters

+

+content - header content text

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-header/header.html b/api1/pl.treksoft.kvision.dropdown/-header/header.html new file mode 100644 index 00000000..cd2a539b --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-header/header.html @@ -0,0 +1,18 @@ + + + +Header.header - kvision + + + +kvision / pl.treksoft.kvision.dropdown / Header / header
+
+

header

+ +fun ListTag.header(content: String? = null, classes: Set<String> = setOf()): Header
+ +fun DropDown.header(content: String? = null, classes: Set<String> = setOf()): Header +

DSL builder extension function.

+

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

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-header/index.html b/api1/pl.treksoft.kvision.dropdown/-header/index.html new file mode 100644 index 00000000..3fc28402 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-header/index.html @@ -0,0 +1,154 @@ + + + +Header - kvision + + + +kvision / pl.treksoft.kvision.dropdown / Header
+
+

Header

+open class Header : Tag +

Menu header component.

+

Constructors

+ + + + + + + +
+

<init>

+		 +Header(content: String? = null, classes: Set<String> = setOf())
+

Inherited Properties

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

align

+		 +var align: Align? +

Text align.

+
+

content

+		 +open var content: String? +

Text content of the tag.

+
+

rich

+		 +open var rich: Boolean +

Determines if content can contain HTML code.

+
+

template

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

Handlebars template.

+
+

templates

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

Handlebars templates for i18n.

+
+

type

+		 +var type: TAG +

Tag type.

+
+

Inherited Functions

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

getSnClass

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

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

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

unaryPlus

+		 +operator fun String.unaryPlus(): Unit
+

Companion Object Functions

+ + + + + + + +
+

header

+		 +fun ListTag.header(content: String? = null, classes: Set<String> = setOf()): Header
+fun DropDown.header(content: String? = null, classes: Set<String> = setOf()): Header +

DSL builder extension function.

+
+

Extension Functions

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

createInstance

+		 +fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+

setData

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

+
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-separator/-init-.html b/api1/pl.treksoft.kvision.dropdown/-separator/-init-.html new file mode 100644 index 00000000..e091319a --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-separator/-init-.html @@ -0,0 +1,19 @@ + + + +Separator.<init> - kvision + + + +kvision / pl.treksoft.kvision.dropdown / Separator / <init>
+
+

<init>

+ +Separator(classes: Set<String> = setOf()) +

Parameters

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-separator/index.html b/api1/pl.treksoft.kvision.dropdown/-separator/index.html new file mode 100644 index 00000000..d5774eab --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-separator/index.html @@ -0,0 +1,154 @@ + + + +Separator - kvision + + + +kvision / pl.treksoft.kvision.dropdown / Separator
+
+

Separator

+open class Separator : Tag +

Menu separator component.

+

Constructors

+ + + + + + + +
+

<init>

+		 +Separator(classes: Set<String> = setOf())
+

Inherited Properties

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

align

+		 +var align: Align? +

Text align.

+
+

content

+		 +open var content: String? +

Text content of the tag.

+
+

rich

+		 +open var rich: Boolean +

Determines if content can contain HTML code.

+
+

template

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

Handlebars template.

+
+

templates

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

Handlebars templates for i18n.

+
+

type

+		 +var type: TAG +

Tag type.

+
+

Inherited Functions

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

getSnClass

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

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

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

unaryPlus

+		 +operator fun String.unaryPlus(): Unit
+

Companion Object Functions

+ + + + + + + +
+

separator

+		 +fun ListTag.separator(classes: Set<String> = setOf()): Separator
+fun DropDown.separator(classes: Set<String> = setOf()): Separator +

DSL builder extension function.

+
+

Extension Functions

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

createInstance

+		 +fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+

setData

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

+
+ + diff --git a/api1/pl.treksoft.kvision.dropdown/-separator/separator.html b/api1/pl.treksoft.kvision.dropdown/-separator/separator.html new file mode 100644 index 00000000..d58d968c --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/-separator/separator.html @@ -0,0 +1,18 @@ + + + +Separator.separator - kvision + + + +kvision / pl.treksoft.kvision.dropdown / Separator / separator
+
+

separator

+ +fun ListTag.separator(classes: Set<String> = setOf()): Separator
+ +fun DropDown.separator(classes: Set<String> = setOf()): Separator +

DSL builder extension function.

+

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

+ + diff --git a/api1/pl.treksoft.kvision.dropdown/index.html b/api1/pl.treksoft.kvision.dropdown/index.html new file mode 100644 index 00000000..7a7a7294 --- /dev/null +++ b/api1/pl.treksoft.kvision.dropdown/index.html @@ -0,0 +1,63 @@ + + + +pl.treksoft.kvision.dropdown - kvision + + + +kvision / pl.treksoft.kvision.dropdown
+
+

Package pl.treksoft.kvision.dropdown

+

Bootstrap dropdown component with support for navigation bars and context menus.

+

Types

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

ContextMenu

+		 +open class ContextMenu : ListTag +

Context menu component.

+
+

DD

+		 +enum class DD +

Useful options for use in DropDown's elements parameter.

+
+

DropDown

+		 +open class DropDown : SimplePanel +

Bootstrap dropdown component.

+
+

Header

+		 +open class Header : Tag +

Menu header component.

+
+

Separator

+		 +open class Separator : Tag +

Menu separator component.

+
+ + -- cgit