From 806edfceeefe7fda47924f97237974e99fe28a02 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 2 Apr 2018 01:35:47 +0200 Subject: API documentantion update --- .../-context-menu/-init-.html | 19 ++++ .../-context-menu/context-menu.html | 16 +++ .../-context-menu/index.html | 118 +++++++++++++++++++++ .../-context-menu/position-menu.html | 20 ++++ 4 files changed, 173 insertions(+) create mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html create mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html create mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/index.html create mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html (limited to 'api/pl.treksoft.kvision.dropdown/-context-menu') diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html b/api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html new file mode 100644 index 00000000..7a456e63 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html @@ -0,0 +1,19 @@ + + + +ContextMenu.<init> - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu / <init>
+
+

<init>

+ +ContextMenu(classes: Set<String> = setOf(), init: ContextMenu.() -> Unit = null) +

Parameters

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html b/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html new file mode 100644 index 00000000..8b896973 --- /dev/null +++ b/api/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(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/api/pl.treksoft.kvision.dropdown/-context-menu/index.html b/api/pl.treksoft.kvision.dropdown/-context-menu/index.html new file mode 100644 index 00000000..2c9823f1 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-context-menu/index.html @@ -0,0 +1,118 @@ + + + +ContextMenu - kvision + + + +kvision / pl.treksoft.kvision.dropdown / ContextMenu
+
+

ContextMenu

+open class ContextMenu : ListTag +

Context menu component.

Constructors

+ + + + + + + +

<init>

+ContextMenu(classes: Set<String> = setOf(), init: ContextMenu.() -> Unit = null)

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 Functions

+ + + + + + + +

contextMenu

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

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html b/api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html new file mode 100644 index 00000000..ded70c2c --- /dev/null +++ b/api/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

+ + -- cgit