• Stars
    star
    222
  • Rank 179,123 (Top 4 %)
  • Language
    Kotlin
  • Created almost 2 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Compose-multiplatform navigation library that leverage Decompose to create an API inspired by Conductor

Decompose Router

Kotlin Experimental Build Kotlin Maven Central

badge-android badge-wearos badge-desktop badge-ios badge-browser

A Compose-multiplatform navigation library that leverage Decompose to create an API inspired by Conductor

A detailed breakdown available in this Medium article

Features

  • 🚏 A Router that manages a FILO stack for your screen configurations
  • 📦 rememberOnRoute() lets you retain your view model across configuration changes and gets cleared when the user leaves the screen
  • ☠️ A SavedStateHandle to restore state gracefully after the process death. (for Android)
  • 🚉 Multiplatform! Supports Android, WearOS, Desktop, iOS and Web

At a glance

// Declare your screen configurations for type-safety
@Serializable 
sealed class Screen {
  object List : Screen()
  data class Details(val detail: String) : Screen()
}

@Composable
fun ListDetailScreen() {
  // Create a router with a stack of screen configurations 🚏
  val router: Router<Screen> = rememberRouter { listOf(List) }

  // Hoist your screens for each configuration 🏗️
  RoutedContent(router = router) { screen ->
    when (screen) {
      List -> ListScreen(
        // Navigate by pushing new configurations on the router 🧭
        onSelectItem = { detail -> router.push(detail) } 
      )
      
      is Details -> DetailsScreen(screen.detail)
    }
  }
}

@Composable
fun DetailsScreen(detail: String) {
  // 📦 Scope an instance (a view model, a state-holder or whatever) to a route with [rememberOnRoute] 
  // This makes your instances survive configuration changes (on android) 🔁
  // And holds-on the instance as long as it is in the backstack 🔗
  // Pass in key if you want to reissue a new instance when key changes 🔑 (optional) 
  val instance: DetailInstance = rememberOnRoute(key = detail) { savedState -> DetailInstance(savedState, detail) }
  
  val state: DetailState by instance.states.collectAsState()
  Text(text = state.detail)
}

// If you want your state to survive process death ☠️ derive your initial state from [SavedStateHandle] 
class DetailInstance(savedState: SavedStateHandle, detail: String) : InstanceKeeper.Instance {
  private val initialState: DetailState = savedState.get() ?: DetailState(detail)
  private val stateFlow = MutableStateFlow(initialState)
  val states: StateFlow<DetailState> = stateFlow
}

Installation and Usage

Documentation here

API Reference here

Licence

Copyright 2023 Isuru Rajapakse

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.