kvision/io.kvision.form

Package-level declarations

Convenient forms implementation, with support for many different input components and easy to define validation.

Types

BoolFormControl

interface BoolFormControl : GenericNonNullableFormControl<Boolean>

Base interface of a form control with a boolean value.

DateFormControl

interface DateFormControl : GenericFormControl<<Error class: unknown class>>

Base interface of a form control with a date value.

FieldLabel

open class FieldLabel(forId: String, content: String? = null, rich: Boolean = false, className: String? = null, init: FieldLabel.() -> Unit? = null) : Tag

Helper class for HTML label element.

Form

class Form<K : Any>(panel: FormPanel<K>? = null, serializer: <Error class: unknown class><K>? = null, customSerializers: Map<KClass<*>, <Error class: unknown class><out <Error class: unknown class>>>? = null)

The form definition class. Can be used directly or indirectly inside a FormPanel.

FormControl

interface FormControl : Component

Base interface of a form control.

FormEnctype

enum FormEnctype : Enum<FormEnctype>

Form encoding types.

FormHorizontalRatio

enum FormHorizontalRatio : Enum<FormHorizontalRatio>

Proportions for horizontal form layout.

FormInput

interface FormInput : Component

FormMethod

enum FormMethod : Enum<FormMethod> , DomAttribute

Form methods.

FormPanel

open class FormPanel<K : Any>(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, serializer: <Error class: unknown class><K>? = null, customSerializers: Map<KClass<*>, <Error class: unknown class><out <Error class: unknown class>>>? = null) : SimplePanel

Bootstrap form component.

FormTarget

enum FormTarget : Enum<FormTarget> , DomAttribute

Form targets.

FormType

enum FormType : Enum<FormType>

Bootstrap form layout options.

GenericFormComponent

interface GenericFormComponent<T> : Component

Base interface of a form component with a generic value.

GenericFormControl

interface GenericFormControl<T> : FormControl, GenericFormComponent<T?>

Base interface of a form control with a generic value.

GenericNonNullableFormControl

interface GenericNonNullableFormControl<T> : FormControl, GenericFormComponent<T>

Base interface of a form control with a generic, non-nullable value.

HelpText

open class HelpText(content: String? = null, rich: Boolean = false) : Tag

Helper class for Bootstrap help text element.

InputSize

enum InputSize : Enum<InputSize> , CssClass

Input controls sizes.

InvalidFeedback

open class InvalidFeedback(content: String? = null, rich: Boolean = false) : Tag

Helper class for Bootstrap invalid feedback element.

KFilesFormControl

interface KFilesFormControl : GenericFormControl<List<<Error class: unknown class>>>

Base interface of a form control with a list of files value.

NumberFormControl

interface NumberFormControl : GenericFormControl<Number>

Base interface of a form control with a numeric value.

StringFormControl

interface StringFormControl : GenericFormControl<String>

Base interface of a form control with a text value.

TriStateFormControl

interface TriStateFormControl : GenericFormControl<Boolean>

Base interface of a form control with a nullable boolean value.

ValidationStatus

enum ValidationStatus : Enum<ValidationStatus> , CssClass

Input controls validation status.

Functions

asJson

fun Map<String, Any?>.asJson(): <Error class: unknown class>

Extension function to convert Map to JSON.

asMap

fun <Error class: unknown class>.asMap(): Map<String, Any?>

Extension function to convert JSON to Map.

fieldLabel

fun Container.fieldLabel(forId: String, content: String? = null, rich: Boolean = false, className: String? = null, init: FieldLabel.() -> Unit? = null): FieldLabel

DSL builder extension function.

form

fun Container.form(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, init: FormPanel<Map<String, Any?>>.() -> Unit? = null): FormPanel<Map<String, Any?>>

DSL builder extension function.

formPanel

inline fun <K : Any> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, customSerializers: Map<KClass<*>, <Error class: unknown class><out <Error class: unknown class>>>? = null, noinline init: FormPanel<K>.() -> Unit? = null): FormPanel<K>

DSL builder extension function.

getDataWithFileContent

suspend fun <K : Any> FormPanel<K>.getDataWithFileContent(): K

suspend fun <K : Any> Form<K>.getDataWithFileContent(): K

Returns current data model with file content read for all KFiles controls.