soil-form/soil.form.compose.text/asFormState

asFormState

fun TextFieldState.asFormState(meta: FormMetaState = rememberFormMetaState()): FormState<TextFieldState>(source)

Converts a TextFieldState into a FormState for single-field form management.

This extension function allows you to treat a single TextFieldState as a complete form, enabling validation, submission handling, and state management for standalone text fields. This is particularly useful for simple forms with a single text input, such as search bars, comment fields, or single-field dialogs.

Usage:

val emailState = rememberTextFieldState()
val form = rememberForm(
    state = emailState.asFormState(),
    onSubmit = { state ->
        // Handle submission with state.text
        sendEmail(state.text.toString())
    }
)

form.Field(
    validator = FieldValidator {
        notBlank { "Email is required" }
        email { "Must be a valid email" }
    },
    render = { field ->
        TextField(
            state = field.state,
            isError = field.hasError
        )
    }
)

Return

A FormState wrapping this TextFieldState for use with the Form composable.

asFormState

Return

Parameters