Skip to content

Commit 5c46ddf

Browse files
authored
add warning about sealed Result (#134)
* add warning about sealed Result * Update readme.md
1 parent 69b490c commit 5c46ddf

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

readme.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,9 @@ NavGraph {
180180
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
181181
`NavController`'s extension `setResult`.
182182

183+
> [!WARNING]
184+
> 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.
185+
183186
```kotlin
184187
import com.kiwi.navigationcompose.typed.Destination
185188
import com.kiwi.navigationcompose.typed.DialogResultEffect

0 commit comments

Comments
 (0)