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 ++++ .../-drop-down/-init-.html | 6 +- .../-drop-down/drop-down.html | 4 +- .../-drop-down/for-navbar.html | 15 +++ .../-drop-down/index.html | 31 ++++-- .../-drop-down/render.html | 18 ++++ .../-header/-init-.html | 21 ++++ .../-header/header.html | 18 ++++ .../-header/index.html | 114 ++++++++++++++++++++ .../-separator/-init-.html | 19 ++++ .../-separator/index.html | 114 ++++++++++++++++++++ .../-separator/separator.html | 18 ++++ api/pl.treksoft.kvision.dropdown/index.html | 29 ++++- 16 files changed, 564 insertions(+), 16 deletions(-) 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 create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html create mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/render.html create mode 100644 api/pl.treksoft.kvision.dropdown/-header/-init-.html create mode 100644 api/pl.treksoft.kvision.dropdown/-header/header.html create mode 100644 api/pl.treksoft.kvision.dropdown/-header/index.html create mode 100644 api/pl.treksoft.kvision.dropdown/-separator/-init-.html create mode 100644 api/pl.treksoft.kvision.dropdown/-separator/index.html create mode 100644 api/pl.treksoft.kvision.dropdown/-separator/separator.html (limited to 'api/pl.treksoft.kvision.dropdown') 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

+ + diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html index 05279737..ccb09c31 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, classes: Set<String> = setOf()) + +DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf())

Parameters

text - the label of the dropdown button

@@ -21,6 +21,8 @@ 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

classes - a set of CSS class names

Constructor
diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html index 7c88d682..84df9354 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html @@ -8,8 +8,8 @@ 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, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown + +fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, 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/for-navbar.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html new file mode 100644 index 00000000..33497640 --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html index f9330ef4..6dbac1d8 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, classes: Set<String> = setOf()) +DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf()) @@ -54,6 +54,15 @@ +

forNavbar

+ + +val forNavbar: Boolean +

determines if the component will be used in a navbar

+ + + +

icon

@@ -176,6 +185,15 @@ +

render

+ + +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+ + + +

toggle

@@ -206,15 +224,6 @@

Returns the array of the children Snabbdom vnodes.

- - -

render

- - -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

- -

Companion Object Functions

@@ -225,7 +234,7 @@

dropDown

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

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/render.html b/api/pl.treksoft.kvision.dropdown/-drop-down/render.html new file mode 100644 index 00000000..6f4b3a6b --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.dropdown/-header/-init-.html b/api/pl.treksoft.kvision.dropdown/-header/-init-.html new file mode 100644 index 00000000..3d47ac09 --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.dropdown/-header/header.html b/api/pl.treksoft.kvision.dropdown/-header/header.html new file mode 100644 index 00000000..cd2a539b --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.dropdown/-header/index.html b/api/pl.treksoft.kvision.dropdown/-header/index.html new file mode 100644 index 00000000..67546316 --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-header/index.html @@ -0,0 +1,114 @@ + + + +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.

+
+

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.

+
+

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.

+
+ + diff --git a/api/pl.treksoft.kvision.dropdown/-separator/-init-.html b/api/pl.treksoft.kvision.dropdown/-separator/-init-.html new file mode 100644 index 00000000..e091319a --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.dropdown/-separator/index.html b/api/pl.treksoft.kvision.dropdown/-separator/index.html new file mode 100644 index 00000000..10411bfb --- /dev/null +++ b/api/pl.treksoft.kvision.dropdown/-separator/index.html @@ -0,0 +1,114 @@ + + + +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.

+
+

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.

+
+

Companion Object Functions

+ + + + + + + +
+

separator

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

DSL builder extension function.

+
+ + diff --git a/api/pl.treksoft.kvision.dropdown/-separator/separator.html b/api/pl.treksoft.kvision.dropdown/-separator/separator.html new file mode 100644 index 00000000..d58d968c --- /dev/null +++ b/api/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/api/pl.treksoft.kvision.dropdown/index.html b/api/pl.treksoft.kvision.dropdown/index.html index d8a75232..7a7a7294 100644 --- a/api/pl.treksoft.kvision.dropdown/index.html +++ b/api/pl.treksoft.kvision.dropdown/index.html @@ -8,12 +8,21 @@ kvision / pl.treksoft.kvision.dropdown

Package pl.treksoft.kvision.dropdown

-

Bootstrap dropdown component.

+

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

Types

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

ContextMenu

+
+open class ContextMenu : ListTag +

Context menu component.

+

DD

@@ -30,6 +39,24 @@

Bootstrap dropdown component.

+

Header

+
+open class Header : Tag +

Menu header component.

+
+

Separator

+
+open class Separator : Tag +

Menu separator component.

+
-- cgit