kvision/io.kvision.form.text

Package-level declarations

Text input components, with password, text area, rich text area and typeahead support.

Types

abstract class AbstractText(label: String? = null, rich: Boolean = false, val floating: Boolean = false, className: String? = null) : SimplePanel, StringFormControl, MutableState<String?>

Base class for form field text components.

AbstractTextInput

abstract class AbstractTextInput(value: String? = null, maxlength: Int? = null, className: String? = null) : Widget, GenericFormComponent<String?> , FormInput, MutableState<String?>

Base class for basic text components.

EnumMask

data class EnumMask(val enum: List<String>, val lazy: Boolean? = null, val eager: Boolean? = null, val placeholderChar: Char? = null)

A text input mask configuration with a list of values.

Imask

class Imask(imask: dynamic) : Mask

Text input mask controller implementation with Imask.js library

ImaskFactory

class ImaskFactory(imask: dynamic) : MaskFactory

ImaskOptions

data class ImaskOptions(val pattern: PatternMask? = null, val range: RangeMask? = null, val enum: EnumMask? = null, val number: NumberMask? = null, val regExp: <Error class: unknown class>? = null, val function: (String) -> Boolean? = null, val list: List<ImaskOptions>? = null, val overwrite: MaskOverwrite? = null) : MaskOptions

A text input mask configuration.

Mask

interface Mask

Generic text input mask controller.

MaskAutofix

enum MaskAutofix : Enum<MaskAutofix>

Text input number mask autofix modes.

MaskFactory

interface MaskFactory

Text input mask controller factory.

MaskManager

object MaskManager

Text input mask controller manager.

MaskOptions

interface MaskOptions

Generic text input mask options.

MaskOverwrite

enum MaskOverwrite : Enum<MaskOverwrite>

Text input mask overwrite modes.

NumberMask

data class NumberMask(val scale: Int? = null, val thousandsSeparator: Char? = null, val padFractionalZeros: Boolean? = null, val normalizeZeros: Boolean? = null, val radix: Char = I18n.detectDecimalSeparator(), val mapToRadix: List<Char> = listOf('.'), val min: Number? = null, val max: Number? = null)

A text input mask configuration for a number value.

Password

open class Password(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, val floating: Boolean = false, init: Password.() -> Unit? = null) : Text

Form field password component.

PatternMask

data class PatternMask(val pattern: String, val lazy: Boolean? = null, val eager: Boolean? = null, val placeholderChar: Char? = null, val definitions: dynamic = null, val blocks: Map<String, ImaskOptions>? = null)

A text input mask configuration with a pattern.

RangeMask

data class RangeMask(val from: Int, val to: Int, val maxLength: Int? = null, val autofix: MaskAutofix? = null, val lazy: Boolean? = null, val eager: Boolean? = null, val placeholderChar: Char? = null)

A text input mask configuration with a range.

RichText

open class RichText(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, allowFileUploads: Boolean = false, init: RichText.() -> Unit? = null) : AbstractText

Form field rich text component.

RichTextInput

open class RichTextInput(value: String? = null, allowFileUploads: Boolean = false, className: String? = null, init: RichTextInput.() -> Unit? = null) : AbstractTextInput

Basic rich text component.

Text

open class Text(type: InputType = InputType.TEXT, value: String? = null, name: String? = null, maxlength: Int? = null, label: String? = null, rich: Boolean = false, val floating: Boolean = false, init: Text.() -> Unit? = null) : AbstractText

Form field text component.

TextArea

open class TextArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, val floating: Boolean = false, init: TextArea.() -> Unit? = null) : AbstractText

Form field textarea component.

TextAreaInput

open class TextAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, className: String? = null, init: TextAreaInput.() -> Unit? = null) : AbstractTextInput

Basic textarea component.

TextInput

open class TextInput(type: InputType = InputType.TEXT, value: String? = null, maxlength: Int? = null, className: String? = null, init: TextInput.() -> Unit? = null) : AbstractTextInput

Basic text component.

TomTypeahead

open class TomTypeahead(options: List<String>? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeahead.() -> Unit? = null) : AbstractText

Form field typeahead component based on Tom Select.

TomTypeaheadInput

open class TomTypeaheadInput(options: List<String>? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, className: String? = null, init: TomTypeaheadInput.() -> Unit? = null) : TextInput

The basic component for typeahead control based on Tom Select.

TomTypeaheadRemote

open class TomTypeaheadRemote<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeaheadRemote<T>.() -> Unit? = null) : AbstractText

The form field component for TomTypeaheadRemote control.

TomTypeaheadRemoteInput

open class TomTypeaheadRemoteInput<out T : Any>(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: TomTypeaheadRemoteInput<T>.() -> Unit? = null) : TomTypeaheadInput

The TomTypeaheadInput control connected to the fullstack service.

Functions

password

fun Container.password(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Password.() -> Unit? = null): Password

DSL builder extension function.

richText

fun Container.richText(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, allowFileUploads: Boolean = false, init: RichText.() -> Unit? = null): RichText

DSL builder extension function.

richTextInput

fun Container.richTextInput(value: String? = null, allowFileUploads: Boolean = false, className: String? = null, init: RichTextInput.() -> Unit? = null): RichTextInput

DSL builder extension function.

text

fun Container.text(type: InputType = InputType.TEXT, value: String? = null, name: String? = null, maxlength: Int? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Text.() -> Unit? = null): Text

DSL builder extension function.

textArea

fun Container.textArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: TextArea.() -> Unit? = null): TextArea

DSL builder extension function.

textAreaInput

fun Container.textAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, className: String? = null, init: TextAreaInput.() -> Unit? = null): TextAreaInput

DSL builder extension function.

textInput

fun Container.textInput(type: InputType = InputType.TEXT, value: String? = null, maxlength: Int? = null, className: String? = null, init: TextInput.() -> Unit? = null): TextInput

DSL builder extension function.

toJs

fun NumberMask.toJs(): dynamic

fun EnumMask.toJs(imask: dynamic): dynamic

fun ImaskOptions.toJs(imask: dynamic): dynamic

fun PatternMask.toJs(imask: dynamic): dynamic

fun RangeMask.toJs(imask: dynamic): dynamic

An extension function to convert configuration class to a JS object.

tomTypeahead

fun Container.tomTypeahead(options: List<String>? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeahead.() -> Unit? = null): TomTypeahead

DSL builder extension function.

tomTypeaheadInput

fun Container.tomTypeaheadInput(options: List<String>? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, className: String? = null, init: TomTypeaheadInput.() -> Unit? = null): TomTypeaheadInput

DSL builder extension function.

tomTypeaheadRemote

fun <T : Any> Container.tomTypeaheadRemote(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: TomTypeaheadRemote<T>.() -> Unit? = null): TomTypeaheadRemote<T>

DSL builder extension function.

tomTypeaheadRemoteInput

fun <T : Any> Container.tomTypeaheadRemoteInput(serviceManager: <Error class: unknown class><T>, function: suspend T.(String?, String?) -> List<String>, stateFunction: () -> String? = null, type: InputType = InputType.TEXT, value: String? = null, tsCallbacks: TomSelectCallbacks? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null, className: String? = null, init: TomTypeaheadRemoteInput<T>.() -> Unit? = null): TomTypeaheadRemoteInput<T>

DSL builder extension function.