Kui

Pronounced 'KOO-ee' or 'KYU-ee'.

What is it?

A Kotlin/JS library for creating component-based user interfaces for use in web applications. With Kui, you can create declarative, stateful, strongly typed components that can be composed to create rich web applications.

Getting started

Add the kui dependency to your build.gradle.kts

repositories {
    // ...
    maven("https://juggernaut0.github.io/m2/repository")
}
dependencies {
    // ...
    implementation("com.github.juggernaut0.kui:kui:0.15.0")
}

Creating simple components is easy:

class HelloWorld(private val name: String) : kui.Component() {
    override fun render() {
        markup().p {
            +"Hello, $name!"
        }
    }
}

fun main() {
    kui.mountComponent(document.body!!, HelloWorld("World"))
}

Check out the usage guide, api docs and examples for more advanced usage.

Building

To publish locally, clone the project and run ./gradlew publishToMavenLocal.

To run tests, firefox headless is currently required. It will be downloaded when tests are run with ./gradlew build.

To run the example project, use ./gradlew :example:run.

TODOs

• Improve error handling & graceful failure (rollback of dom?) in case of exception during rendering
• Improve testing utility library for testing user applications
  • Virtual rendering
  • Shallow renders
• Bug: Props construction is not binary compatible when new params are added to the constructor