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 --- .../-form-panel/-init-.html | 6 +- .../-form-panel/condensed.html | 21 + .../-form-panel/create.html | 4 +- .../-form-panel/form-panel.html | 16 - .../-form-panel/index.html | 801 ++++++++++++++++++++- 5 files changed, 819 insertions(+), 29 deletions(-) create mode 100644 api/pl.treksoft.kvision.form/-form-panel/condensed.html delete mode 100644 api/pl.treksoft.kvision.form/-form-panel/form-panel.html (limited to 'api/pl.treksoft.kvision.form/-form-panel') diff --git a/api/pl.treksoft.kvision.form/-form-panel/-init-.html b/api/pl.treksoft.kvision.form/-form-panel/-init-.html index fb819c2f..95b6ea03 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/-init-.html +++ b/api/pl.treksoft.kvision.form/-form-panel/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / <init>

<init>

- -

FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), serializer: KSerializer<K>)

+ +

FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, classes: Set<String> = setOf(), serializer: KSerializer<K>)

Parameters

K - model class type

@@ -21,6 +21,8 @@ enctype - form encoding type

type - form layout

+condensed - determines if the form is condensed.

classes - set of CSS class names

diff --git a/api/pl.treksoft.kvision.form/-form-panel/condensed.html b/api/pl.treksoft.kvision.form/-form-panel/condensed.html new file mode 100644 index 00000000..a8af1f1e --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/condensed.html @@ -0,0 +1,21 @@ + + + +FormPanel.condensed - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / condensed
+
+

condensed

+ +var condensed: Boolean +

Determines if the form is condensed.

Getter
+

Determines if the form is condensed.

Setter
+

Determines if the form is condensed.

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/create.html b/api/pl.treksoft.kvision.form/-form-panel/create.html index eebfe203..a0bbec40 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/create.html +++ b/api/pl.treksoft.kvision.form/-form-panel/create.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form / FormPanel / create

create

- -

inline fun <reified K : Any> create(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), noinline init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K>

+ +

inline fun <reified K : Any> create(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, classes: Set<String> = setOf(), noinline init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K>

diff --git a/api/pl.treksoft.kvision.form/-form-panel/form-panel.html b/api/pl.treksoft.kvision.form/-form-panel/form-panel.html deleted file mode 100644 index b14d48d2..00000000 --- a/api/pl.treksoft.kvision.form/-form-panel/form-panel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -FormPanel.formPanel - kvision - - - -kvision / pl.treksoft.kvision.form / FormPanel / formPanel
-
-

formPanel

- -

inline fun <reified K : Any> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), noinline init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K>

DSL builder extension function.

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

- - diff --git a/api/pl.treksoft.kvision.form/-form-panel/index.html b/api/pl.treksoft.kvision.form/-form-panel/index.html index 53a980db..dfef50c0 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/index.html +++ b/api/pl.treksoft.kvision.form/-form-panel/index.html @@ -18,7 +18,7 @@

<init>

FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), serializer: KSerializer<K>)

FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, classes: Set<String> = setOf(), serializer: KSerializer<K>)

@@ -45,6 +45,15 @@ +

condensed

+ + +var condensed: Boolean +

Determines if the form is condensed.

+ + + +

enctype

@@ -108,6 +117,18 @@ +

Inherited Properties

+ + + + + + + +

children

+val children: MutableList<Component>

Functions

@@ -312,22 +333,120 @@

create

fun <K : Any> create(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, classes: Set<String> = setOf(), init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K>

+ + +

fun <K : Any> create(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K>

Extension Functions

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

+ 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`
- formPanel + addBsRounded	-`fun <K : Any> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K>` +`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, ico`