Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DevSrSouza committed Jun 4, 2024
1 parent d7705ad commit 585a004
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
8 changes: 2 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
5 changes: 3 additions & 2 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
```kotlin
dependencies {
val voyagerVersion = "1.0.0"
val voyagerVersion = "1.1.0-beta02"
// Multiplatform
Expand Down Expand Up @@ -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" }
Expand Down Expand Up @@ -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: | | |
4 changes: 2 additions & 2 deletions docs/transitions-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 585a004

Please sign in to comment.