SprawlKt

SprawlKt is a Kotlin port of sprawl, which is a flexible, high-performance, cross-platform UI layout library originally written in Rust.

Goals

This project serves as a pure Kotlin port of the original Rust implementation.

Usage (not ready yet)

SprawlKt is built in Kotlin and can be used by any JVM languages.

Kotlin

1. Add the repository to your Gradle project

repositories {
    maven("https://raw.githubusercontent.com/OrionCraftMC/OrionMaven/main/")
}

2. Add the dependency to your project

dependencies {
    implementation("io.github.orioncraftmc:SprawlKt:0.1.0")
}

3. You're ready to go!

// main.kt
import io.github.orioncraftmc.sprawlkt.geometry.Size
import io.github.orioncraftmc.sprawlkt.node.Node
import io.github.orioncraftmc.sprawlkt.node.Sprawl
import io.github.orioncraftmc.sprawlkt.style.Style
import io.github.orioncraftmc.sprawlkt.style.enums.StretchDimension

fun main() {
    // You can use the `Node` class to create a new node.
    val child = Node(
        Style(
            size = Size(StretchDimension.Percent(0.5f), StretchDimension.Auto),
        ),
        emptyList()
    )

    // Or if you prefer, you can use the `Sprawl` class to also create new nodes.
    val node = Sprawl.newNode(
        Style(
            size = Size(StretchDimension.Points(100f), StretchDimension.Points(100f)),
        ),
        listOf(child)
    )

    val layout = Sprawl.computeLayout(node, Size.undefinedNumber())

    println(layout)
}

Testing (not ready yet)

Sprawl is tested by validating that layouts written in SprawlKt perform the same as in Chrome. This is done by rendering an equivalent layout in HTML and then generating a Kotlin test case which asserts that the resulting layout is the same when run through Stretch.

You can run these tests without setting up a webdriver environment but if you are looking to add any test case you will need to install chromedriver.

Once you have chromedriver installed and available in PATH you can re-generate all tests by running gradle :gentest:run.

To add a new test case add another HTML file to /test_fixtures following the current tests as a template for new tests.

Relationship to Yoga

If you're in the mood for some Yoga but can't depend on native libraries, also check out our pure Java port of Yoga called meditate-layout.

Yoga is a cross-platform implementation of Flexbox written in C. Yoga is a fantastic project but has some fundamental issues which the upstream project hopes to resolve. Compared to Yoga they aim to have a stronger adherence to web standards, a flexible architecture eventually supporting multiple layout algorithms, and future performance improvements including multi-threaded layout. In addition to this they aim to use a safer language with a more modern codebase.