Customizable JSON Schema-based forms enable dynamic form creation and validation using JSON configuration. Supports various platforms with integration for Material and Bulma styling components.
Customizable JSON Schema-based forms for Kotlin and Compose
This project aims to reimplement JSON Forms in Kotlin for use in Compose-based applications. Rather than defining its own formats or standards, this repo adopts JSON for form configuration and layout of well-known or standardized formats. Form fields and validation is provided in JSON Schema format, and the way the form is laid out and displayed is through JSON Forms format format. Using JSON as as the form definition gives an easy, portable way to display and dynamically change forms in your application.
This repo aims to support all features of the original JSON Forms library, which is written in Javascript, as well as following similar architectural patterns. For all topic related to the JSON format itself, that library's documentation will be a valid reference for this library.
See the video below for an example form in action:
https://user-images.githubusercontent.com/6157866/179068902-a8e3da2e-2a00-4a30-8c92-596f2ded2d3d.mov
This project currently supports Android and Desktop targets with the json-forms-compose-material artifact, which uses
json-kotlin-schema for schema validation.
JavaScript is also supported for Compose DOM (no Canvas implementation yet), using the json-forms-compose-bulma
artifact. This displays forms based on Bulma CSS for styling and class names. JS target uses
Ajv for schema validation (the same validator library used in the original
JSON Forms library).
repositories {
mavenCentral()
}
// for plain JVM or Android projects
dependencies {
implementation("io.github.copper-leaf:json-forms-compose-material:{{site.version}}")
}
// for multiplatform projects
kotlin {
sourceSets {
jvmMain getting {
dependencies {
implementation()
}
}
androidMain getting {
dependencies {
implementation()
}
}
commonMain getting {
dependencies {
implementation()
}
}
}
}
See the website for detailed documentation and usage instructions.
The documentation site, and this library in general, is very much a POC at this point, and everything is subject to change without warning. But you can always find the most up-to-date usage in the example apps.
Kotlin JSON Forms is licensed under the BSD 3-Clause License, see LICENSE.md.
This project depends on the following libraries:
Surfaced from shared tags and platforms — no rankings paid for.