Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/copper-leaf/kotlin-json-forms
Customizable JSON Schema-based forms for Kotlin and Compose
https://github.com/copper-leaf/kotlin-json-forms
compose forms json-schema kotlin
Last synced: 2 months ago
JSON representation
Customizable JSON Schema-based forms for Kotlin and Compose
- Host: GitHub
- URL: https://github.com/copper-leaf/kotlin-json-forms
- Owner: copper-leaf
- License: bsd-3-clause
- Created: 2022-07-07T13:40:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T21:51:15.000Z (about 2 years ago)
- Last Synced: 2024-10-01T05:02:15.347Z (3 months ago)
- Topics: compose, forms, json-schema, kotlin
- Language: Kotlin
- Homepage: https://copper-leaf.github.io/kotlin-json-forms/
- Size: 8.01 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
---
---
# Kotlin JSON Forms
> Customizable JSON Schema-based forms for Kotlin and Compose
[](https://github.com/copper-leaf/kotlin-json-forms/releases)
[](https://search.maven.org/artifact/io.github.copper-leaf/json-forms-core)
This project aims to reimplement [JSON Forms](https://github.com/eclipsesource/jsonforms) 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](https://json-schema.org/), and the way the form is laid out and displayed is through
[JSON Forms format](https://github.com/eclipsesource/jsonforms) 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](https://github.com/eclipsesource/jsonforms) 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
# Supported Platforms/Features
This project currently supports Android and Desktop targets with the `json-forms-compose-material` artifact, which uses
[json-kotlin-schema](https://github.com/pwall567/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](https://bulma.io/) for styling and class names. JS target uses
[Ajv](https://github.com/ajv-validator/ajv) for schema validation (the same validator library used in the original
[JSON Forms](https://github.com/eclipsesource/jsonforms) library).
# Installation
```kotlin
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 {
val jvmMain by getting {
dependencies {
// Forms using Material components for Compose Desktop
implementation("io.github.copper-leaf:json-forms-compose-material:{{site.version}}")
}
}
val androidMain by getting {
dependencies {
// Forms using Material components for Compose Android
implementation("io.github.copper-leaf:json-forms-compose-material:{{site.version}}")
}
}
val commonMain by getting {
dependencies {
// Forms using HTML widgets for Compose Web DOM, using Bulma CSS framework for styling
implementation("io.github.copper-leaf:json-forms-compose-bulma:{{site.version}}")
}
}
}
}
```
# Documentation
See the [website](https://copper-leaf.github.io/kotlin-json-forms/) 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](https://github.com/copper-leaf/kotlin-json-forms/tree/main/example).
# License
Kotlin JSON Forms is licensed under the BSD 3-Clause License, see [LICENSE.md](https://github.com/copper-leaf/kotlin-json-forms/tree/main/LICENSE.md).
# References and Dependencies
- [JSON Schema formal specification](https://json-schema.org/)
- [Original JSON Forms Javascript library](https://github.com/eclipsesource/jsonforms)
This project depends on the following libraries:
- [json-kotlin-schema](https://github.com/pwall567/json-kotlin-schema) for providing JSON parsing and validation on JVM,
which itself depends on many other Java or Kotlin JSON libraries by the same author
- [Ajv](https://github.com/ajv-validator/ajv) for providing JSON parsing and validation on JS
- [richtext-compose-multiplatform](https://github.com/Wavesonics/richtext-compose-multiplatform) for rich text editor capabilities
- [compose-code-editor](https://github.com/Qawaz/compose-code-editor) for code editor capabilities