soil-form/soil.form.compose

Package-level declarations

Types

class FieldControl<V>(val name: FieldName, val policy: FieldPolicy, val rule: FormRule<V>, val defaultValue: V, val getValue: () -> V, val setValue: (V) -> Unit, val getErrors: () -> FieldErrors, val setErrors: (FieldErrors) -> Unit, val shouldTrigger: (FieldValidateOn) -> Boolean, val isEnabled: () -> Boolean)

Represents a field control in a form.

FormScope

@Stable

class FormScope<T : Any>

A scope to manage the state and actions of input fields in a form.

FormState

@Stable

interface FormState<T>

The managed state of a form.

SubmissionControl

@Stable

class SubmissionControl<T>(val policy: SubmissionPolicy, val rule: FormRule<T>, val submit: () -> Unit, val initialValue: T, val getValue: () -> T, val hasError: () -> Boolean, val getFieldKeys: () -> FormFieldNames, val isSubmitting: () -> Boolean, val isSubmitted: () -> Boolean, val getSubmitCount: () -> Int)

Represents a submission control in a form.

Functions

Controller

@Composable

fun <V> Controller(control: FieldControl<V>, content: @Composable (Field<V>) -> Unit)

A controller for a form field control.

@Composable

fun <T> Controller(control: SubmissionControl<T>, content: @Composable (Submission) -> Unit)

A controller for a form submission control.

Form

@Composable

fun <T : Any> Form(onSubmit: suspend (T) -> Unit, initialValue: T, modifier: Modifier = Modifier, onError: (err: Throwable) -> Unit? = null, saver: Saver<T, Any> = autoSaver(), key: Any? = null, policy: FormPolicy = FormPolicy.Default, coroutineScope: CoroutineScope = rememberCoroutineScope(), content: @Composable FormScope<T>.() -> Unit)

A Form to manage the state and actions of input fields, and create a child block of FormScope.

onFocusChanged

fun Modifier.onFocusChanged(target: Field<*>): Modifier

Adds a callback to be invoked when the focus state of the field changes.

rememberFieldRuleControl

@Composable

fun <T : Any, V> FormScope<T>.rememberFieldRuleControl(name: FieldName, select: T.() -> V, update: T.(V) -> T, enabled: T.() -> Boolean = { true }, dependsOn: Set<FieldName>? = null, builder: ValidationRuleBuilder<V>.() -> Unit): FieldControl<V>

@Composable

Remembers a field control for the given field name with the given rule set.

rememberSubmissionRuleAutoControl

@Composable

fun <T : Any> FormScope<T>.rememberSubmissionRuleAutoControl(): SubmissionControl<T>

Remembers a submission rule control that automatically controls state of the form.

rememberWatch

@Composable

fun <T : Any, V> FormScope<T>.rememberWatch(select: T.() -> V): V

Remembers a watch value that automatically updates when the form state changes.

serializationSaver

@ExperimentalSerializationApi

inline fun <T> serializationSaver(serializer: KSerializer<T> = serializer(), bundler: Bundler = Bundler): Saver<T, Any>

Create an Saver for Kotlin Serialization.