camper
0.3.2indexedOffers an easy-to-use solution for building customizable forms with various fields and validators, supporting data binding for seamless form data management and validation.
0
Stars
—
Used by
dependents
—
Health
/ 100
This is a Kotlin Multiplatform compatible fork of https://github.com/benjamin-luescher/compose-form To make the separation clean, I have change the project name and package.
Android KMP Form Library
This library provides an easy-to-use and customizable solution for building forms in Kotlin Multiplatform. It includes form fields such as text input, pickers, checkbox, and more, with built-in validators to ensure accurate user input. Data binding is also supported, making it easy to work with form data in your code.
Whether you're building a complex registration form or a simple feedback form, this library has you covered.
TODO: Update with KMP gradle instructions
Getting Started
To start using the library in your Android Compose project, follow these steps:
- Add the JitPack repository to your settings.gradle file
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
// ...
maven { url "https://jitpack.io" }
}
}
Note: In older Android projects, the repositories are defined in the root build.gradle file.
- Add the dependency in your build.gradle file.
implementation 'com.steeplesoft:camper:0.3.0-SNAPSHOT'
Easy example
In a first example we create a simple form with two text fields. The form will look like this:
- Create a your form class with your form field annotations (
@FormField)
class MainForm(): Form() {
override fun self(): Form {
return this
}
override fun = listOf(name, lastName)
name = FieldState(
state = mutableStateOf<String?>(),
validators = mutableListOf(NotEmptyValidator())
)
lastName = FieldState(
state = mutableStateOf<String?>()
)
}
TODO - Hilt-free example
- Create a ViewModel for your form.
@HiltViewModel
class MainViewModel @Inject constructor(
resourcesProvider: ResourcesProvider
): ViewModel() {
var form = MainForm(resourcesProvider)
fun validate() {
form.validate(true)
Log.d("MainViewModel", "Validate (form is valid: ${form.isValid})")
}
}
- Add the fields in your composable UI.
Column {
TextField(
label = "Name",
form = viewModel.form,
fieldState = viewModel.form.name,
).Field()
TextField(
label = "Last Name",
form = viewModel.form,
fieldState = viewModel.form.lastName
).Field()
}
Extended Form example
We now try to make a more complex form with different validators, date fields, password fields and searchable pickers. This is how the form will look like:
- Create a form class with form fields. Define form fields by the
@FormFieldannotation.
- Create a ViewModel for your form.
@HiltViewModel
class MainViewModel @Inject constructor(
resourcesProvider: ResourcesProvider
): ViewModel() {
var form = MainForm(resourcesProvider)
fun validate() {
form.validate(true)
Log.d("MainViewModel", "Validate (form is valid: ${form.isValid})")
}
}
- Add the fields in your composable UI.
Features
- A variety of form fields to choose from, including text input, pickers, checkbox, and more
- Built-in validators to ensure accurate user input
- Data binding for easy management of form data in your code
License
This library is licensed under the MIT License.