Skip to content
Unidirectional state container for Android and Kotlin
Branch: master
Clone or download
gumil Disable jetifier
Update navigation to 2.0.0-rc2
Latest commit 9c44106 Mar 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
art
buildSrc
detekt Set max detekt issues to 0 Mar 4, 2019
gradle
kaskade-coroutines
kaskade-livedata
kaskade-rx
kaskade
sample-android
sample-kotlin
.gitignore
.travis.yml
LICENSE
README.md
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
settings.gradle.kts

README.md

Kaskade

Build Status Android Arsenal codecov Codacy Badge

State Container for Kotlin and Android.

The name comes from cascade, a waterfall, which reflects the objective of the library to make flows easier with unidirectional data flow.

Inspired by MVI or Model View Intent.

Kaskade

Why Kaskade?

  • Lightweight - enforces unidirectional data flow without the use of external dependencies.
  • Modular - can be easily substituted to different implementation with or without the use of another library.
  • Extendable - in relation to modular and lightweight, it's important to extend the API and create user defined implementation to fit specific requirements.
  • Unidirectional - data flows in one direction.
  • Predictable - control on state changes and action triggers.
  • DSL - able to hide complexity in a fluent way.

Usage

Create the Action and State objects.

Note: objects are only used here for simplicity in real projects data classes are more appropriate

internal sealed class TestState : State {
    object State1 : TestState()
    object State2 : TestState()
    object State3 : TestState()
}

internal sealed class TestAction : Action {
    object Action1 : TestAction()
    object Action2 : TestAction()
    object Action3 : TestAction()
}

Create Kaskade with TestState.State1 as initial state

val kaskade = Kaskade.create<TestAction, TestState>(TestState.State1) {
    on<TestAction.Action1> {
        TestState.State1
    }

    on<TestAction.Action2> {
        TestState.State2
    }

    on<TestAction.Action3> {
        TestState.State3
    }
}

Adding actions to Action with parameter ActionState

on<TestAction.Action1> { actionState ->
    // do any side effects when returning a new state
    TestState.State1
}

Observing states

kaskade.onStateChanged = {
    // Do something with new state
    render(it)
}

Observing states with Flow

kaskade.stateFlow.subscribe {
    // Do something with new state
    render(it)
}

Executing actions

kaskade.process(TestAction.Action1)

Documentation

Check out the wiki for documentation.

Some of the topics covered are:

Also check out sample-android for Android use cases and sample-kotlin for kotlin only project

Installation

Add the JitPack repository to your build file

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Add the dependency

dependencies {
  // core module
  implementation 'com.github.gumil.kaskade:kaskade:0.2.2'
  // coroutines module
  implementation 'com.github.gumil.kaskade:kaskade-coroutines:0.2.2'
  // rx module
  implementation 'com.github.gumil.kaskade:kaskade-rx:0.2.2'
  // livedata module
  implementation 'com.github.gumil.kaskade:kaskade-livedata:0.2.2'
}
You can’t perform that action at this time.