From 5c46ddf77d2ea6fb8d2987c16f15f358a8c1f51c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20=C5=A0kr=C3=A1=C5=A1ek?= Date: Mon, 13 May 2024 09:46:31 +0200 Subject: [PATCH] add warning about sealed Result (#134) * add warning about sealed Result * Update readme.md --- readme.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/readme.md b/readme.md index 1111a64..d42d51f 100644 --- a/readme.md +++ b/readme.md @@ -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