rememberFormMetaState
Remembers form metadata state with automatic state restoration.
This function is specifically designed for scenarios where your form values contain mutable data types (like TextFieldState
) that would require custom Saver implementations when using rememberFormState. Instead of implementing complex Savers, you can manage field state restoration manually (e.g., with rememberTextFieldState
) and use this function to handle only the form metadata restoration.
When to use this function:
Your form contains mutable data types like
TextFieldState
,MutableState
, etc.You want to avoid implementing custom Saver logic for complex form data
You prefer to manage individual field state restoration manually
When NOT to use this function:
Your form uses immutable data classes - use rememberFormState instead
You want automatic restoration of both form data and metadata together
Usage pattern:
@Composable
fun MyForm() {
// Manage field state restoration manually
val nameState = rememberTextFieldState()
val emailState = rememberTextFieldState()
// Use rememberFormMetaState for metadata only
val formMeta = rememberFormMetaState(
policy = FormPolicy()
)
// Create FormState with remember (no custom Saver needed)
val formState = remember(formMeta.key) {
FormState(
value = FormData(name = nameState, email = emailState),
meta = formMeta
)
}
}
Return
The remembered FormMetaState with automatic state restoration.
Parameters
The form policy that defines validation behavior and form options.
See also
For immutable form data that can use automatic Savers.