Skip to content

Commit

Permalink
add warning about sealed Result (#134)
Browse files Browse the repository at this point in the history
* add warning about sealed Result

* Update readme.md
  • Loading branch information
hrach authored May 13, 2024
1 parent 69b490c commit 5c46ddf
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,9 @@ NavGraph {
Another set of functionality is provided to support the result sharing. First, define the destination as `ResultDestination` type and specify the result type class. Then open the screen as usual and utilize `ComposableResultEffect` or `DialogResultEffect` to observe the destination's result. To send the result, use
`NavController`'s extension `setResult`.

> [!WARNING]
> Do not make the Result class sealed as it may cause an issue (see kiwicom/navigation-compose-typed#133). You may put a sealed type to a Result's property.
```kotlin
import com.kiwi.navigationcompose.typed.Destination
import com.kiwi.navigationcompose.typed.DialogResultEffect
Expand Down

0 comments on commit 5c46ddf

Please sign in to comment.