mjlblabla / decompose-router Goto Github PK

View Code? Open in Web Editor NEW

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

Kotlin 95.70% CSS 0.25% Swift 3.55% HTML 0.50%

decompose-router's Introduction

Decompose Router

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 stack, pages or slot for your screen configurations
📦 rememberOnRoute() lets you retain your view model across configuration changes and gets cleared when the user leaves the screen
🚉 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)
    }
  }
}

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.

Recommend Projects