Flows

Atlas supports flows to handle state management.

To get started using flows please import the api library and plugin (Swift Generator) into your project (shared.gradle file):

plugins {
    id("io.github.thearchitect123.atlasFlowsGenPlugin") // generates the swift classes used to bridge to Flows on Kotlin side
}
 kotlin {
   sourceSets {
        commonMain.dependencies {
            implementation("io.github.thearchitect123:atlas-flow:+") // contains the DSL Api used to access the flows api
        }
   }
 }

Get Started

To get started using Flows, please use the below class:

val myVar = MutableAtlasFlow("") // the data type can be anything

You can add an observer to run on the current context, or the main thread

// observe on current context
myVar.asStateFlow().asCFlow().observe {
}
// observe data on main thread
myVar.asStateFlow().asCFlow().observeMain {
}

To broadcast data and notify all listeners, you can use:

myVar.postValueOnMainThread("MyValue") // notifies on main thread
myVar.setValueOnContext("MyValue") // notifies on main thread

To get the current value:

val currentVal = myVar.getCurrentValue()

What about iOS?

This depends on how your project is written.

SwiftUI

On Kotlin side:

import com.architect.atlas.architecture.mvvm.ViewModel
class MyViewModel : ViewModel(){
    val name = MutableAtlasFlow("")
    val samples = MutableAtlasFlow("")
}
data class SampleProcess(val result: String)

On your Swift (Xcode Side)

import SwiftUI
import shared
struct ContentView: View {
    let vm: MyViewModel
    @StateObject var name: FlowBinding<String>
    @StateObject var samples: FlowBinding<[SampleProcess]>
    init(vm: MyViewModel) {
        self.vm = vm
        _name = StateObject(wrappedValue: FlowBinding(flow: vm.testText.asSwiftFlow(), adapter: stringAdapter))
        _samples = StateObject(wrappedValue: FlowBinding(flow: vm.resultsSamples.asSwiftFlow(), adapter: makeListAdapter(SampleProcess.self)))
    }
    var body: some View {
        List(samples.value, id: \.id) { person in
            Text(person.name)
        }
        VStack{
            Text(name) // to bind the state directly
            Text("").bindTextTwoWay(vm.testText.asSwiftFlow()) // if using the extensions
        }.onAppear{
            // to fetch the current data
            let currentValue = stringAdapter.fromKotlin(vm.testText.asSwiftFlow().getValue())
            // to observe for changes
            observe(vm.testText.asSwiftFlow(), adapter: stringAdapter) { res in
                print ("RES \(res)")
            }
        }
        // if you need to bind a list of data
        List {
            ForEachBinding(samples.listBinding, id: \.self) { sample in
                Text(sample[\.result].value())
            }
        }
    }
}

Flows

Get Started

What about iOS?

SwiftUI

UIKit