TextInput

class TextInput(val id: String, val label: TitleItem.DefaultTitleItem, val hintText: String? = null, val required: Boolean? = false, val textInputType: Input.TextInput.TextInputType? = TextInputType.Singleline, val placeholder: String? = null, val prefixText: String? = null, val maximumCharacterCount: Int? = null, val textContentType: Input.TextInput.TextContentType? = null, val keyboardType: Input.TextInput.TextKeyboardType? = null) : Input

Represents a text input on a form.

Parameters

textInputType

The TextInputType type of text expected for this input.

placeholder

Placeholder text displayed to users.

prefixText

Text which is prefixed to the final output.

maximumCharacterCount

The maximum characters this text input accepts.

textContentType

The TextContentType content type for this input.

keyboardType

The suggested TextKeyboardType keyboard type which should be used to collect input from the user.

Constructors

Link copied to clipboard
constructor(id: String, label: TitleItem.DefaultTitleItem, hintText: String? = null, required: Boolean? = false, textInputType: Input.TextInput.TextInputType? = TextInputType.Singleline, placeholder: String? = null, prefixText: String? = null, maximumCharacterCount: Int? = null, textContentType: Input.TextInput.TextContentType? = null, keyboardType: Input.TextInput.TextKeyboardType? = null)

Types

Link copied to clipboard
Link copied to clipboard

An enum that defines TextInput.textInputType text input types.

Properties

Link copied to clipboard
val hintText: String? = null
Link copied to clipboard
val id: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val maximumCharacterCount: Int? = null
Link copied to clipboard
val placeholder: String? = null
Link copied to clipboard
val prefixText: String? = null
Link copied to clipboard
val required: Boolean? = false
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Transient
var value: String?

The current text value for this input.

Functions

Link copied to clipboard
open override fun validate(): Input.ValidationError?

Use this validation to determine if the current value for this input is valid.