From 585a0046e14a9d27e438919801bda1513d3119c2 Mon Sep 17 00:00:00 2001 From: Gabriel Souza Date: Tue, 4 Jun 2024 20:40:42 -0300 Subject: [PATCH] Update docs --- docs/index.md | 8 ++------ docs/setup.md | 5 +++-- docs/transitions-api.md | 4 ++-- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/index.md b/docs/index.md index 98d7584a..486cee01 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,7 +38,7 @@ Turn on the Warp Drive and enjoy the voyage 🖖 ### **Features** -* [Supported platforms](setup.md#platform-compatibility): Android, iOS, Desktop, Web +* [Supported platforms](setup.md#platform-compatibility): Android, iOS, Desktop, Web, Wasm (since 1.1.0-alpha03) * [Linear navigation](navigation/) * [BottomSheet navigation](navigation/bottomsheet-navigation.md) * [Tab navigation](navigation/tab-navigation.md) like [Youtube app](https://play.google.com/store/apps/details?id=com.google.android.youtube) @@ -52,11 +52,7 @@ Turn on the Warp Drive and enjoy the voyage 🖖 * [Lifecycle](lifecycle.md) callbacks * [Back press](back-press.md) handling * [Deep linking](deep-links.md) support - -### Roadmap - -* Wasm support -* Navigator scoped ViewModels +* [Lifecycle KMP support](android-viewmodel/viewmodel-kmp.md) since 1.1.0-beta01 ### Credits diff --git a/docs/setup.md b/docs/setup.md index c0630453..0b67e4e3 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -13,7 +13,7 @@ ```kotlin dependencies { - val voyagerVersion = "1.0.0" + val voyagerVersion = "1.1.0-beta02" // Multiplatform @@ -57,7 +57,7 @@ ```toml [versions] - voyager = "1.0.0" + voyager = "1.1.0-beta02" [libraries] voyager-navigator = { module = "cafe.adriel.voyager:voyager-navigator", version.ref = "voyager" } @@ -86,6 +86,7 @@ | voyager-transitions | :white_check_mark: | :white_check_mark: | :white_check_mark: | | voyager-koin | :white_check_mark: | :white_check_mark: | :white_check_mark: | | voyager-kodein | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| voyager-lifecycle-kmp | :white_check_mark: | :white_check_mark: | :white_check_mark: | | voyager-hilt | :white_check_mark: | | | | voyager-rxjava | :white_check_mark: | :white_check_mark: | | | voyager-livedata | :white_check_mark: | | | diff --git a/docs/transitions-api.md b/docs/transitions-api.md index 79c57e6c..b190145a 100644 --- a/docs/transitions-api.md +++ b/docs/transitions-api.md @@ -13,8 +13,8 @@ setContent { } ``` -!!! danger - There is a know bug using any Transition APIs can leaky ScreenModels or ViewModels, this happens because Voyager by default +!!! danger "Known bug" + There is a known bug using any Transition APIs can leaky ScreenModels or ViewModels, this happens because Voyager by default dispose Screens in the next Composition tick after a `pop` or `replace` is called, but the transition only finish later, so the ScreenModel or ViewModel is re created or cleared to early. For this purpose since Voyager `1.1.0-beta02` we have introduce a new API to fix this issue. For more details on the issue see [#106](https://github.com/adrielcafe/voyager/issues/106).