kvision-material/io.kvision.material.textfield/MdFilledTextField

MdFilledTextField

open class MdFilledTextField(disabled: Boolean = false, error: Boolean = false, errorText: String? = null, label: String? = null, required: Boolean = false, value: String? = null, prefixText: String? = null, suffixText: String? = null, supportingText: String? = null, rows: Int = 2, cols: Int = 20, inputMode: TextFieldInputMode? = null, max: TextFieldRangeConstraint? = null, maxLength: Int = -1, min: TextFieldRangeConstraint? = null, minLength: Int = -1, pattern: String? = null, placeholder: String? = null, readOnly: Boolean = false, multiple: Boolean = false, step: Number? = null, type: TextFieldInputType = TextFieldInputType.Text, autoComplete: <Error class: unknown class>? = null, name: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledTextField.() -> Unit? = null) : MdTextField

Filled text field type.

Author

Maanrifa Bacar Ali

Constructors

MdFilledTextField

constructor(disabled: Boolean = false, error: Boolean = false, errorText: String? = null, label: String? = null, required: Boolean = false, value: String? = null, prefixText: String? = null, suffixText: String? = null, supportingText: String? = null, rows: Int = 2, cols: Int = 20, inputMode: TextFieldInputMode? = null, max: TextFieldRangeConstraint? = null, maxLength: Int = -1, min: TextFieldRangeConstraint? = null, minLength: Int = -1, pattern: String? = null, placeholder: String? = null, readOnly: Boolean = false, multiple: Boolean = false, step: Number? = null, type: TextFieldInputType = TextFieldInputType.Text, autoComplete: <Error class: unknown class>? = null, name: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledTextField.() -> Unit? = null)

Properties

autoComplete

var autoComplete: <Error class: unknown class>

Describes what, if any, type of autocomplete functionality the input should provide. https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete

cols

var cols: <Error class: unknown class>

The number of cols to display for a TextFieldInputType.TextArea text field.

disabled

var disabled: <Error class: unknown class>

Whether or not the widget is disabled.

error

var error: <Error class: unknown class>

Gets or sets whether or not the text field is in a visually invalid state. This error state overrides the error state controlled by reportValidity.

errorText

var errorText: <Error class: unknown class>

The error message that replaces supporting text when error is true. If errorText is an empty string, then the supporting text will continue to show. This error message overrides the error message displayed by reportValidity.

form

val form: <Error class: unknown class>?

The associated form element with which this element's value will submit.

inputMode

var inputMode: <Error class: unknown class>

Hints at the type of data that might be entered by the user while editing the element or its contents. This allows a browser to display an appropriate virtual keyboard. https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode

label

var label: <Error class: unknown class>

Label of the text field.

labels

val labels: <Error class: unknown class>?

The labels this element is associated with.

max

var max: <Error class: unknown class>

Defines the greatest value in the range of permitted values. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max

maxLength

var maxLength: <Error class: unknown class>

The maximum number of characters a user can enter into the text field. Set to -1 for none. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength

min

var min: <Error class: unknown class>

Defines the most negative value in the range of permitted values. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min

minLength

var minLength: <Error class: unknown class>

The minimum number of characters a user can enter into the text field. Set to -1 for none. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength

multiple

var multiple: <Error class: unknown class>

Indicates that input accepts multiple email addresses. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/email#multiple

name

var name: <Error class: unknown class>

The name to use in form submission.

parent

open var parent: <Error class: unknown class>?

pattern

var pattern: <Error class: unknown class>

A regular expression that the text field's value must match to pass constraint validation. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern

placeholder

var placeholder: <Error class: unknown class>

Defines the text displayed in a form control when the text field has no value. https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/placeholder

prefixText

var prefixText: <Error class: unknown class>

An optional prefix to display before the input value.

readOnly

var readOnly: <Error class: unknown class>

Indicates whether or not a user should be able to edit the text field's value. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly

required

var required: <Error class: unknown class>

Indicates that the component must provides a valid value when participating in form submission.

rows

var rows: <Error class: unknown class>

The number of rows to display for a TextFieldInputType.TextArea text field.

selectionDirection

var selectionDirection: <Error class: unknown class>

The direction in which selection occurred.

selectionEnd

var selectionEnd: <Error class: unknown class>

The end position or offset of a text selection.

selectionStart

var selectionStart: <Error class: unknown class>

The starting position or offset of a text selection.

step

var step: <Error class: unknown class>

Returns or sets the element's step attribute, which works with min and max to limit the increments at which a numeric or date-time value can be set. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step

suffixText

var suffixText: <Error class: unknown class>

An optional suffix to display after the input value.

supportingText

var supportingText: <Error class: unknown class>

Conveys additional information below the text field, such as how it should be used.

type

var type: <Error class: unknown class>

The type to use, defaults to "text". The type greatly changes how the text field behaves.

validationMessage

val validationMessage: String?

Message to display when the component value is not valid.

validity

val validity: <Error class: unknown class>?

Gets the element's current validity state.

value

var value: <Error class: unknown class>

The value that is submitted to the form.

valueAsDate

var valueAsDate: <Error class: unknown class>

The text field's value as a Date.

valueAsNumber

var valueAsNumber: <Error class: unknown class>

The text field's value as a number.

willValidate

val willValidate: Boolean

Indicates that the element is a candidate for constraint validation.

Functions

afterCreate

open override fun afterCreate(node: <Error class: unknown class>)

buildAttributeSet

open override fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

checkValidity

fun checkValidity(): Boolean

Indicates the validity of the value of the element. If the value is invalid, this method also fires the invalid event on the element.

dispose

open fun dispose()

leading

open override fun leading(component: <Error class: unknown class>?)

leadingIcon

fun HasLeadingSlot.leadingIcon(name: String): MdIcon

Sets the icon identified by name to the leading slot.

render

open fun render(): <Error class: unknown class>

reportValidity

fun reportValidity(): Boolean

Performs the same validity checking steps as the checkValidity method. If the value is invalid, this method also fires the invalid event on the element, and (if the event isn't canceled) reports the problem to the user.

reset

fun reset()

Reset the text field to its default value.

select

fun select()

Selects all the text in the text field.

setCustomValidity

fun setCustomValidity(message: String)

Sets a custom validity message for the underlying element.

setRangeText

fun setRangeText(replacement: String)