Library facilitates form validation with type-safe rules, form state management, and seamless integration into UI projects using a DSL or chained style for validation declaration.
English | 中文
ViForm is a Kotlin library for form validation, mainly aimed at Compose Multiplatform projects. It has the following features:
Apply the KopyBuilder Gradle plugin
plugins {
id("io.github.windedge.kopybuilder") version "0.2.4"
}
Add dependency to Multiplatform project
kotlin {
sourceSets {
commonMain {
dependencies {
implementation("io.github.windedge.viform:viform-core:0.2.2")
// Optional
implementation("io.github.windedge.viform:viform-compose:0.2.2")
}
}
}
}
Add dependency to JVM project
dependencies {
implementation("io.github.windedge.viform:viform-core:0.2.2")
// Optional
implementation("io.github.windedge.viform:viform-compose:0.2.2")
}
Define validation rules:
io.github.windedge.copybuilder.KopyBuilder
io.github.windedge.viform.core.*
(
name: String = ,
email: String? = ,
password: String = ,
confirmPassword: String = ,
)
schema = FormSchema.create<Signup> {
field(Signup::name) {
required()
isAlphaNumeric()
}
field(Signup::email).optional {
isEmail()
}
field(Signup::password).required().lengthBetween(, )
field(Signup::confirmPassword).required().lengthBetween(, )
.custom() {
it == field(Signup::password).currentValue
}
}
Use in Jetpack Compose project:
When compiling the WebAssembly (WASM) target, you may encounter the error Can't link symbol kotlin.internal.ir/ANDAND.
import io.github.windedge.viform.compose.use
fun SignupApp() {
val form = schema.buildForm(Signup())
Column {
form.use {
field(it::name) {
TextInput("User Name: ", currentValue, hasError, errorMessage, onValueChange = {
setValue(it, validate = true) // validate synchronously
})
}
field(it::email) {
watchLazily { validate() } // validate asynchronously
TextInput("Email:", currentValue ?: "", hasError, errorMessage, onValueChange=::setValue)
}
field(it::password) {
watchLazily { if (it.isNotEmpty()) validate() }
TextInput("Password:", currentValue, hasError, errorMessage, onValueChange=::setValue)
}
field(it::confirmPassword) {
watchLazily { if (it.isNotEmpty()) validate() }
TextInput("Confirm Password:", currentValue, hasError, errorMessage, onValueChange=::setValue)
}
// validate on submit
Button(onClick = {
if(form.validate()) {
val signup = form.pop() // get form data
// ...
}
}) { Text("Sign up") }
}
}
}
Surfaced from shared tags and platforms — no rankings paid for.