Kodices
0.4.0indexedParses JSON models to describe user interfaces, featuring a reference GUI implementation and a sample application demonstrating usage.
1
Stars
—
Used by
dependents
—
Health
/ 100
Kodices
Kodices is a Server-Driven UI framework for Kotlin Multiplatform. It allows you to define your user interfaces using JSON, which can be fetched from a server at runtime. This enables you to update your app's UI without shipping a new version to the app store. A reference implementation and an example that use Compose multiplatform are provided, however you can integrate Kodices with Native UI or other UI frameworks.
Repository content
This repository contains different modules to help you get started:
+--------------+ +--------------------+ +-----------------+
| | | | | |
| KodexServer |---->| Kodices |---->| Piktographs |
| (JSON source)| | (Core functonality)| | (Reference UI) |
| | | | | |
+--------------+ +--------------------+ +-----------------+
- KodexServer: A sample Ktor server that provides the JSON UI definitions. (Note: This module is currently a work-in-progress.)
- Kodices: The core module that parses the JSON and creates a platform-agnostic model of the UI.
- Piktographs: A reference implementation that renders the UI models using Jetpack Compose for Android, iOS, and Desktop.
- SampleApp: An example application that demonstrates how to use these components together.
Getting Started
To get started, clone the repository and build the project.
Usage
You can add Kodices to your own Kotlin Multiplatform project by adding the following dependencies to your build.gradle.kts file.
dependencies {
// Core parsing logic
implementation("com.iktwo:kodices:<latest_version>")
// Jetpack Compose UI rendering
implementation("com.iktwo:piktographs:<latest_version>")
}
Please replace <latest_version> with the latest version from the releases page.
Here is a minimal example of how to parse a JSON string and render it with Piktographs:
import com.iktwo.kodices.KodicesParser
import com.iktwo.piktographs.PageUI
import androidx.compose.runtime.Composable
@Composable
fun MyScreen(jsonString: String) {
// 1. Initialize the parser
val kodicesParser = KodicesParser()
// 2. Parse the JSON string into a Content object
val content = kodicesParser.parseJSONToContent(jsonString)
(content != ) {
PageUI(content)
}
}
Subprojects
- Kodices: The core KMP library for parsing UI models.
- Piktographs: A reference UI implementation using Compose Multiplatform.
- SampleApp: A sample application demonstrating the usage of the library.
- KodexServer: A sample Ktor-based server for serving UI models.