hooks2/xyz.junerver.compose.hooks.useform

Package-level declarations

Types

CustomValidator

abstract class CustomValidator(val message: String, val validator: (field: Any?) -> Boolean) : Validator

data class Email(val message: String = EMAIL_MESSAGE) : Validator

object Form

class FormInstance

Form controller, The Form component needs to pass this controller instance so that the controller can control the component outside.

class FormScope

Form Component scope

data class Mobile(val message: String = MOBILE_MESSAGE) : Validator

data class Phone(val message: String = PHONE_MESSAGE) : Validator

data class Regex(val message: String = REGEX_MESSAGE, val regex: String) : Validator

data class Required(val message: String = REQUIRED_MESSAGE) : Validator

sealed interface Validator

Validator，used to verify whether form fields are legal

Functions

fun Form(formInstance: FormInstance = Form.useForm(), children: @Composable FormScope.() -> Unit)

Headless Form Component

fun ~~useForm~~(): FormInstance

fun Form.useForm(): FormInstance

useFormInstance

fun Form.useFormInstance(): FormInstance

方便子组件获取到 FormInstance

fun <T> Form.useWatch(fieldName: String, formInstance: FormInstance): State<T?>

使用这个 Hook 你可以在 FormScope 外直接获取一个字段的内容状态

fun Array<Validator>.validateField(fieldValue: Any?, pass: Validator.() -> Boolean, fail: Validator.() -> Boolean): Boolean

Verify the value of a field using a list of validators