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 --- .../-context-menu/context-menu.html | 16 - .../-context-menu/index.html | 834 ++++++++++++++++++-- .../-direction/-d-r-o-p-d-o-w-n.html | 14 + .../-direction/-d-r-o-p-l-e-f-t.html | 14 + .../-direction/-d-r-o-p-r-i-g-h-t.html | 14 + .../-direction/-d-r-o-p-u-p.html | 14 + .../-direction/index.html | 61 ++ .../-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 - .../-header/header.html | 18 - .../-header/index.html | 773 ++++++++++++++++++- .../-separator/index.html | 758 ++++++++++++++++-- .../-separator/separator.html | 18 - .../cm-link-disabled.html | 16 + api/pl.treksoft.kvision.dropdown/cm-link.html | 16 + api/pl.treksoft.kvision.dropdown/context-menu.html | 16 + .../dd-link-disabled.html | 16 + api/pl.treksoft.kvision.dropdown/dd-link.html | 16 + api/pl.treksoft.kvision.dropdown/drop-down.html | 16 + api/pl.treksoft.kvision.dropdown/header.html | 18 + api/pl.treksoft.kvision.dropdown/index.html | 101 ++- api/pl.treksoft.kvision.dropdown/separator.html | 18 + .../set-context-menu.html | 20 + 28 files changed, 3486 insertions(+), 249 deletions(-) delete mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html create mode 100644 api/pl.treksoft.kvision.dropdown/-direction/-d-r-o-p-d-o-w-n.html create mode 100644 api/pl.treksoft.kvision.dropdown/-direction/-d-r-o-p-l-e-f-t.html create mode 100644 api/pl.treksoft.kvision.dropdown/-direction/-d-r-o-p-r-i-g-h-t.html create mode 100644 api/pl.treksoft.kvision.dropdown/-direction/-d-r-o-p-u-p.html create mode 100644 api/pl.treksoft.kvision.dropdown/-direction/index.html 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 delete mode 100644 api/pl.treksoft.kvision.dropdown/-header/header.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-separator/separator.html create mode 100644 api/pl.treksoft.kvision.dropdown/cm-link-disabled.html create mode 100644 api/pl.treksoft.kvision.dropdown/cm-link.html create mode 100644 api/pl.treksoft.kvision.dropdown/context-menu.html create mode 100644 api/pl.treksoft.kvision.dropdown/dd-link-disabled.html create mode 100644 api/pl.treksoft.kvision.dropdown/dd-link.html create mode 100644 api/pl.treksoft.kvision.dropdown/drop-down.html create mode 100644 api/pl.treksoft.kvision.dropdown/header.html create mode 100644 api/pl.treksoft.kvision.dropdown/separator.html create mode 100644 api/pl.treksoft.kvision.dropdown/set-context-menu.html (limited to 'api/pl.treksoft.kvision.dropdown') diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html b/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html deleted file mode 100644 index 409d2e1b..00000000 --- a/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/api/pl.treksoft.kvision.dropdown/-context-menu/index.html b/api/pl.treksoft.kvision.dropdown/-context-menu/index.html index 0f9dc915..03b025e3 100644 --- a/api/pl.treksoft.kvision.dropdown/-context-menu/index.html +++ b/api/pl.treksoft.kvision.dropdown/-context-menu/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.dropdown / ContextMenu

ContextMenu

-open class ContextMenu : ListTag +open class ContextMenu : Div

Context menu component.

Constructors

@@ -36,120 +36,167 @@

Inherited Properties

Functions

+ +

elements

positionMenu

-var elements: List<String>? -

List of elements.

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

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

Companion Object Properties

+ + +const val DEFAULT_FIXED_POS_X: Int +const val DEFAULT_FIXED_POS_Y: Int

rich

DEFAULT_FIXED_POS_X

-var rich: Boolean -

Determines if elements can contain HTML code.

type

DEFAULT_FIXED_POS_Y

-var type: ListType -

List type.

Functions

Extension Functions

+ + + + + + + + - -

positionMenu

addBsBgColor

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

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

+fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit

addBsBorder

+fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit

addBsClearfix

+fun Component.addBsClearfix(): Unit

Inherited Functions

- - + + + + - -

childrenVNodes

addBsColor

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

Returns the array of the children Snabbdom vnodes.

+fun Component.addBsColor(bsColor: BsColor): Unit

addBsRounded

+fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit

getSnClass

bold

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

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

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.

render

button

-open fun render(): VNode -

Renders current component as a Snabbdom vnode.

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.

Companion Object Properties

- - +

fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup

DSL builder extension function.

+ +

fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas

DSL builder extension function.

+ - -

DEFAULT_FIXED_POS_X

buttonGroup

-const val DEFAULT_FIXED_POS_X: Int

DEFAULT_FIXED_POS_Y

canvas

-const val DEFAULT_FIXED_POS_Y: Int

Companion Object Functions

- - + + + + + + + + + + + + + + + + + + + + - -

- contextMenu + chart	-`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu` +`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. +
+ cmLink +	+`fun ContextMenu.cmLink(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link` + DSL builder extension function for a link in a context menu list. +
+ cmLinkDisabled +	+`fun ContextMenu.cmLinkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link` + DSL builder extension function for a disabled link in a context menu list. +
+ contextMenu +	+`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu` DSL builder extension function.

Extension Functions

- - + + +

createInstance

@@ -159,6 +206,689 @@

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)