App Navigation

Atlas is designed for ViewModel to ViewModel navigation.

To get started using it please import the plugin into your project (shared.gradle file):

plugins {
    id("io.github.thearchitect123.atlasNavigationEngineGenerator") // generates the navigation graphs for each platform
}

How to use

Currently Atlas supports only Compose, UIKit and SwiftUI.

First each screen/composable needs to be registered with the annotation.

If your screen/composable is the first instance in the navigation graph, please mark it with isInital=true

@AtlasScreen(myViewModel::class, isInitial=true)

Otherwise empty/false by default for all other screens.

@AtlasScreen(myViewModel::class)

In your compose project (android side), register your composable

@AtlasScreen(myFirstViewModel::class, isInitial=true)
@Composable
fun myCompose (vm: myFirstViewModel){
}
@AtlasScreen(mySecondViewModel::class)
@Composable
fun mySecondScreen (vm: mySecondViewModel){
}

And in your SwiftUI project. The viewmodels are injected into your widgets automatically by the navigation engine.

//@AtlasScreen(viewModel: myFirstViewModel.self, initial: true)
struct ContentViewFirst: View {
    let vm : myFirstViewModel?
    var body: some View {
        Text("")
    }
}
//@AtlasScreen(viewModel: mySecondViewModel.self)
struct ContentViewSecond: View {
    let vm : mySecondViewModel?
    var body: some View {
        Text("")
    }
}

How to configure the ViewModels?

Inside your shared module:

@ViewModels
class myFirstViewModel : ViewModel(){
}
@ViewModels
class mySecondViewModel : ViewModel(){
}

To navigate from myFirstViewModel to mySecondViewModel, inside your myFirstViewModel:

@ViewModels
class myFirstViewModel : ViewModel(){
    fun goToNextPage(){ // invoke this function in your UI (button press for example)
        AtlasDI.resolveService<AtlasNavigationService>().navigateToPage(mySecondViewModel::class)
    }
}

AtlasNavigationService is a navigation service that is generated inside each of your platforms main folders (iOSMain, androidMain, etc). You will need to register this service with the IOC container

    AtlasDI.registerInterfaceToInstance(AtlasNavigationService::class, AtlasNavigation)

Please run this somewhere on AppStartup.

How to pass parameters between screens?

To allow your viewmodels to be able to handle pushing/popping parameters, you will need to add these interfaces (you can configure any data types you want to be able to pass):

Pushable<T>  // T can be String, or Int, or any enum or class
Poppable<T>  // sets the return type (passed from the screen returned from)

@ViewModels
class myFirstViewModel : ViewModel(), Pushable<String>, Poppable<Int>{
    fun goToNextPage(){  // triggers mySecondViewModel onPushParams, and assigns "My Sample VM" in params
        AtlasDI.resolveService<AtlasNavigationService>().navigateToPage(mySecondViewModel::class, "My Sample VM")
    }
    override fun onPushParams(params: String) {
    }
    override fun onPopParams(params: Int) {
    }
}
@ViewModels
class mySecondViewModel : ViewModel(), Pushable<String>, Poppable<Int>{
    fun popScreen(){  // triggers myFirstViewModel onPopParams, and assigns 55 in params
        AtlasDI.resolveService<AtlasNavigationService>().popPage(55)
    }
    override fun onPushParams(params: String) {
    }
    override fun onPopParams(params: Int) {
    }
}