1.0.0-alpha14

soil-form/soil.form.compose.text/FormTextField

FormTextField

interface FormTextField : BasicFormField(source)

A control interface for managing form text field state with built-in TextFieldState integration.

This interface provides seamless integration with Compose's TextFieldState API, offering automatic validation, focus management, and error handling for text input fields.

Usage:

form.Field(
    selector = { it.emailState },
    render = { field ->
        TextField(
            state = field.state,
            isError = field.hasError,
            modifier = Modifier.onFocusChanged { state ->
                field.handleFocus(state.isFocused)
            }
        )
    }
)

Properties

abstract val error: FieldError

The current validation error for this field, if any.

val BasicFormField.hasError: Boolean

Whether the field currently has any validation errors.

abstract val isEnabled: Boolean

Whether the field is enabled for user interaction.

abstract val isFocused: Boolean

Whether the field currently has focus.

abstract val isTouched: Boolean

Whether the field has been touched (focused and then blurred) by the user.

abstract val name: FieldName

The unique name identifier for this field within the form.

abstract val state: TextFieldState

The TextFieldState that manages the text content and editing operations. This state can be directly passed to Compose text field components.

Functions

abstract fun handleFocus(hasFocus: Boolean)

Handles focus state changes by calling onFocus() or onBlur() as appropriate.

abstract fun onBlur()

Marks the field as blurred (not focused) and touched.

abstract fun onFocus()

Marks the field as focused.

abstract fun trigger(mode: FieldValidationMode): Boolean

Manually triggers validation for this field with the specified mode.