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 --- .../-date-time/clear-btn.html | 15 - .../-date-time/date-time.html | 16 - .../-date-time/disabled-dates.html | 15 + .../-date-time/enabled-dates.html | 15 + .../-date-time/ignore-readonly.html | 15 + .../-date-time/index.html | 869 ++++++++++++++++++++- .../-date-time/invalid-feedback.html | 16 + .../-date-time/max-date.html | 15 + .../-date-time/min-date.html | 15 + .../-date-time/minute-step.html | 15 - .../-date-time/show-clear.html | 15 + .../-date-time/show-close.html | 15 + .../-date-time/show-meridian.html | 15 - .../-date-time/show-today-button.html | 15 + .../-date-time/side-by-side.html | 15 + .../-date-time/stepping.html | 15 + .../-date-time/today-btn.html | 15 - .../-date-time/today-highlight.html | 15 - .../-date-time/toggle-popup.html | 15 + .../-date-time/validation-info.html | 16 - .../-date-time/week-start.html | 15 - 21 files changed, 1018 insertions(+), 154 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/date-time.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/invalid-feedback.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/max-date.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/min-date.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/minute-step.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/show-clear.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/show-close.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/show-meridian.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/show-today-button.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/side-by-side.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/stepping.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/today-btn.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/today-highlight.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time/toggle-popup.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/validation-info.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/week-start.html (limited to 'api/pl.treksoft.kvision.form.time/-date-time') diff --git a/api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html b/api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html deleted file mode 100644 index e4ba22de..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.clearBtn - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / clearBtn
-
-

clearBtn

- -var clearBtn: Boolean -

Determines if Clear button should be visible.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/date-time.html b/api/pl.treksoft.kvision.form.time/-date-time/date-time.html deleted file mode 100644 index ac96d8de..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/date-time.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.dateTime - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / dateTime
-
-

dateTime

- -

fun Container.dateTime(value: Date? = null, name: String? = null, format: String = "YYYY-MM-DD HH:mm", label: String? = null, rich: Boolean = false, init: (DateTime.() -> Unit)? = null): DateTime

DSL builder extension function.

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

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html new file mode 100644 index 00000000..df0ab973 --- /dev/null +++ b/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html @@ -0,0 +1,15 @@ + + + +DateTime.disabledDates - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTime / disabledDates
+
+

disabledDates

+ +var disabledDates: Array<Date> +

An array of disabled dates.

+ + diff --git a/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html new file mode 100644 index 00000000..6e92d71b --- /dev/null +++ b/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html @@ -0,0 +1,15 @@ + + + +DateTime.enabledDates - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTime / enabledDates
+
+

enabledDates

+ +var enabledDates: Array<Date> +

An array of enabled dates.

+ + diff --git a/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html b/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html new file mode 100644 index 00000000..05c1de36 --- /dev/null +++ b/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html @@ -0,0 +1,15 @@ + + + +DateTime.ignoreReadonly - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTime / ignoreReadonly
+
+

ignoreReadonly

+ +var ignoreReadonly: Boolean +

Allow date picker for readonly component..

+ + diff --git a/api/pl.treksoft.kvision.form.time/-date-time/index.html b/api/pl.treksoft.kvision.form.time/-date-time/index.html index ed1b6e5f..13ce56d3 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/index.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/index.html @@ -36,20 +36,29 @@ -

clearBtn

daysOfWeekDisabled

-var clearBtn: Boolean -

Determines if Clear button should be visible.

+var daysOfWeekDisabled: Array<Int> +

Days of the week that should be disabled. Multiple values should be comma separated.

daysOfWeekDisabled

disabledDates

-var daysOfWeekDisabled: Array<Int> -

Days of the week that should be disabled. Multiple values should be comma separated.

+var disabledDates: Array<Date> +

An array of disabled dates.

+ + + + +

enabledDates

+ + +var enabledDates: Array<Date> +

An array of enabled dates.

@@ -72,6 +81,15 @@ +

ignoreReadonly

+ + +var ignoreReadonly: Boolean +

Allow date picker for readonly component..

+ + + +

input

@@ -81,6 +99,15 @@ +

invalidFeedback

+ + +val invalidFeedback: InvalidFeedback +

Invalid feedback component.

+ + + +

label

@@ -90,11 +117,20 @@ -

minuteStep

maxDate

-var minuteStep: Int -

The increment used to build the hour view.

+var maxDate: Date? +

Prevents date selection after this date.

+ + + + +

minDate

+ + +var minDate: Date? +

Prevents date selection before this date.

@@ -126,38 +162,47 @@ -

showMeridian

showClear

-var showMeridian: Boolean -

Determines if meridian views are visible in day and hour views.

+var showClear: Boolean +

Determines if Clear button should be visible.

+ + + + +

showClose

+ + +var showClose: Boolean +

Determines if Close button should be visible.

todayBtn

showTodayButton

-var todayBtn: Boolean +var showTodayButton: Boolean

Determines if Today button should be visible.

todayHighlight

sideBySide

-var todayHighlight: Boolean -

Determines if the current day should be highlighted.

+var sideBySide: Boolean +

Shows date and time pickers side by side.

validationInfo

stepping

-val validationInfo: HelpBlock -

Validation info component.

+var stepping: Int +

The increment used to build the hour view.

@@ -169,14 +214,17 @@

Date/time input value.

+ + +

Inherited Properties

+ + +val children: MutableList<Component>

weekStart

children

-var weekStart: Int -

Day of the week start. 0 (Sunday) to 6 (Saturday).

@@ -257,6 +305,15 @@

Open date/time chooser popup.

+ + +

togglePopup

+ + +open fun togglePopup(): Unit +

Toggle date/time chooser popup.

+ +

Inherited Functions

@@ -354,23 +411,116 @@ -

Companion Object Functions

Extension Functions

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

- dateTime + addBsBgColor +	+`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
+ addBsBorder +	+`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
+ addBsClearfix +	+`fun Component.addBsClearfix(): Unit`
+ addBsColor +	+`fun Component.addBsColor(bsColor: BsColor): Unit`
+ addBsRounded	-`fun Container.dateTime(value: Date? = null, name: String? = null, format: String = "YYYY-MM-DD HH:mm", label: String? = null, rich: Boolean = false, init: (DateTime.() -> Unit)? = null): DateTime` +`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
+ bold +	+`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. +
+ button +	+`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. +
+ buttonGroup +	+`fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup` + DSL builder extension function. +
+ canvas +	+`fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas` + DSL builder extension function. +
+ chart +	+`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. +
+ contextMenu +	+`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu` DSL builder extension function.

Extension Functions

- - + + +

createInstance

@@ -380,6 +530,661 @@

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: (