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 --- .../-spinner-input/-init-.html | 6 +- .../-spinner-input/button-style.html | 21 + .../-spinner-input/buttons-type.html | 10 +- .../-spinner-input/index.html | 141 +++- .../-spinner-input/spinner-input.html | 16 - .../-spinner-input/validation-status.html | 22 + .../-spinner/-init-.html | 4 +- .../-spinner/button-style.html | 15 + .../-spinner/buttons-type.html | 4 +- .../-spinner/index.html | 815 ++++++++++++++++++++- .../-spinner/invalid-feedback.html | 16 + .../-spinner/spinner.html | 16 - .../-spinner/style-for-horizontal-form-panel.html | 16 + .../-spinner/validation-info.html | 16 - .../-spinner/validator-error.html | 16 + api/pl.treksoft.kvision.form.spinner/index.html | 23 + .../spinner-input.html | 16 + api/pl.treksoft.kvision.form.spinner/spinner.html | 16 + 18 files changed, 1093 insertions(+), 96 deletions(-) create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html delete mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/spinner-input.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner-input/validation-status.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner/button-style.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner/invalid-feedback.html delete mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner/spinner.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner/style-for-horizontal-form-panel.html delete mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.spinner/-spinner/validator-error.html create mode 100644 api/pl.treksoft.kvision.form.spinner/spinner-input.html create mode 100644 api/pl.treksoft.kvision.form.spinner/spinner.html (limited to 'api/pl.treksoft.kvision.form.spinner') diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html index 0799e4b2..a6548e93 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / <init>

<init>

- -

SpinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, classes: Set<String> = setOf())

+ +

SpinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, buttonStyle: ButtonStyle? = null, classes: Set<String> = setOf())

Parameters

value - spinner value

@@ -25,6 +25,8 @@ buttonsType - spinner buttons type

forceType - spinner force rounding type

+buttonStyle - the style of the up/down buttons

classes - a set of CSS class names

Constructor
diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html new file mode 100644 index 00000000..60dcae96 --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html @@ -0,0 +1,21 @@ + + + +SpinnerInput.buttonStyle - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / buttonStyle
+
+

buttonStyle

+ +var buttonStyle: ButtonStyle? +

The style of the up/down buttons.

Getter
+

The style of the up/down buttons.

Setter
+

The style of the up/down buttons.

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html index b9191d5b..237f5317 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html @@ -9,13 +9,7 @@

buttonsType

-var buttonsType: ButtonsType -

Spinner buttons type.

Getter
-

Spinner buttons type.

Setter
-

Spinner buttons type.

+val buttonsType: ButtonsType +

spinner buttons type

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html index d14962de..543e6c48 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html @@ -18,7 +18,7 @@

<init>

SpinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, classes: Set<String> = setOf())

SpinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, buttonStyle: ButtonStyle? = null, classes: Set<String> = setOf())

@@ -36,11 +36,20 @@ +

buttonStyle

+ + +var buttonStyle: ButtonStyle? +

The style of the up/down buttons.

+ + + +

buttonsType

-var buttonsType: ButtonsType -

Spinner buttons type.

+val buttonsType: ButtonsType +

spinner buttons type

@@ -144,6 +153,15 @@ +

validationStatus

+ + +open var validationStatus: ValidationStatus? +

The validation status of the input.

+ + + +

value

@@ -222,6 +240,15 @@ +

tabindex

+ + +var tabindex: Int? +

A tabindex attribute of generated HTML element.

+ + + +

title

@@ -592,15 +619,6 @@ -

setContextMenu

- - -open fun setContextMenu(contextMenu: ContextMenu): Widget -

Sets context menu for the current widget.

- - - -

setDragDropData

@@ -690,23 +708,53 @@ -

Companion Object Functions

Extension Functions

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

- spinnerInput + addBsBgColor +	+`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
+ addBsBorder +	+`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
+ addBsClearfix	-`fun Container.spinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, classes: Set<String> = setOf(), init: (SpinnerInput.() -> Unit)? = null): SpinnerInput` +`fun Component.addBsClearfix(): Unit`
+ addBsColor +	+`fun Component.addBsColor(bsColor: BsColor): Unit`
+ addBsRounded +	+`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
+ contextMenu +	+`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu` DSL builder extension function.

Extension Functions

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

createInstance @@ -716,6 +764,59 @@ Helper function for creating JavaScript objects from dynamic constructors.
+ removeBsBgColor +	+`fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit`
+ removeBsBorder +	+`fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit`
+ removeBsClearfix +	+`fun Component.removeBsClearfix(): Unit`
+ removeBsColor +	+`fun Component.removeBsColor(bsColor: BsColor): Unit`
+ removeBsRounded +	+`fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit`
+ setContextMenu +	+`fun Widget.setContextMenu(contextMenu: ContextMenu): Widget` + Sets context menu for the current widget. +
+ style +	+`fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style` + DSL builder extension function. +

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/spinner-input.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/spinner-input.html deleted file mode 100644 index 03c23910..00000000 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/spinner-input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -SpinnerInput.spinnerInput - kvision - - - -kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / spinnerInput
-
-

spinnerInput

- -

fun Container.spinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, classes: Set<String> = setOf(), init: (SpinnerInput.() -> Unit)? = null): SpinnerInput

DSL builder extension function.

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

- - diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/validation-status.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/validation-status.html new file mode 100644 index 00000000..48a5352e --- /dev/null +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/validation-status.html @@ -0,0 +1,22 @@ + + + +SpinnerInput.validationStatus - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / validationStatus
+
+

validationStatus

+ +open var validationStatus: ValidationStatus? +

Overrides FormInput.validationStatus

The validation status of the input.

Getter
+

The validation status of the input.

Setter
+

The validation status of the input.

+ + diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html b/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html index c1b6525e..f89e5120 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / <init>

<init>

- -

Spinner(value: Number? = null, name: String? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL,