Quick start

Modifying build script

Add a new dependency to the gradle build script

KotlinGroovy

implementation("io.github.arttttt.simplemvi:simplemvi:<version>")

implementation "io.github.arttttt.simplemvi:simplemvi:<version>"

Creating Store

This easiest way to create a Store is declaring an object which impletents the Store interface

class MyCoolStore : Store<MyCoolStore.Intent, MyCoolStore.State, MyCoolStore.SideEffect> {

    sealed interface Intent

    data class State(val value: Int = 0)

    sealed interface SideEffect
}

Now it's necessary to implement the Store interface itself. It can be done by using the createStore function

class MyCoolStore : Store</* omitted code */> by createStore(
    name = storeName<MyCoolStore>(),
    initialState = //Store initial state,
    actor = //Store actor,
) {

    // Omitted code
}

There are only three mandatory parameters that need to be provided: name, initialState and actor

name - name of the Store. It's used for logging and debugging. It's possible to pass null

initialState - initial state of the Store. A brand new instance of the Store is created with this provided state

actor - a place where all business logic is placed

Creating Actor

Actor can be created by using dsl

class MyCoolStore : Store</* omitted code */> by createStore(
    name = //Store name
    initialState = //Store initial state,
    actor = actorDsl {
        onInit { /* code */ }

        onIntent<Intent.DoCoolStuff> { intent -> /* code */ }

        onDestroy { /* code */ }
    },
) {
    sealed interface Intent {
        data object DoCoolStuff : Intent
    }

    // Omitted code
}

onInit - called when the Store initialized

onIntent<T> - called when a declared intent received

onDestroy - called when store is about to be destroyed, but CoroutineScope is still active

That's basically it!