FormValidator/com.initbase.formvalidator

Package-level declarations

Types

customValidationResponse

typealias customValidationResponse = Pair<Boolean, String?>

ErrorSafeValue

data class ErrorSafeValue<T>(val value: T, val initial: T = value, val error: String? = null)

Wraps a form field value together with its validation error and change-tracking state.

FormValidator

class FormValidator(val fields: List<validationField> = emptyList(), val flow: FormValidator.Flow = Down)

SnackBarProperties

data class SnackBarProperties(val message: String? = null, val title: String = "Validation Error", val modifier: Modifier = Modifier.fillMaxWidth(), val margin: PaddingValues = PaddingValues(16.dp), val titleStyle: TextStyle? = null, val messageStyle: TextStyle? = null, val backgroundColor: Color? = null, val shape: Shape = RoundedCornerShape(8.dp), val visibleDuration: Duration = 3000.milliseconds, val enterTransition: EnterTransition = fadeIn() + expandIn(), val exitTransition: ExitTransition = shrinkOut() + fadeOut())

SnackBar properties for Form

validationField

typealias validationField = FormValidator.ValidationField<*>

Properties

LocalFormValidator

val LocalFormValidator: ProvidableCompositionLocal<FormValidator>

Used to reference the validator in nested components. ``LocalFormValidator.current``

Functions

errorSafe

fun <T> errorSafe(value: T): MutableState<ErrorSafeValue<T>>

Creates a MutableState holding an ErrorSafeValue for value.

Form

@Composable

fun Form(modifier: Modifier = Modifier, validator: FormValidator = FormValidator(), snackBarProperties: SnackBarProperties = SnackBarProperties(), content: @Composable ColumnScope.() -> Unit = {})

Overload of Form that shows a snack bar with validation error. Suggestion -> When this overload is used, do not show the error for each field in the form with FormValidator.ValidationField.onError since the purpose of this form is to show one error at a time.

@Composable

fun Form(modifier: Modifier = Modifier, validator: FormValidator = FormValidator(), verticalArrangement: Arrangement.Vertical = Arrangement.Top, horizontalAlignment: Alignment.Horizontal = Alignment.Start, content: @Composable ColumnScope.() -> Unit = {})