Skip to content

Commit 6db7fd1

Browse files
authored
add warning about link generation failures (#358)
1 parent 7f524b8 commit 6db7fd1

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

docs/ff-concepts/navigation-routing/deep-dynamic-linking.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -752,10 +752,36 @@ Here’s a quick demo to show how to configure those values inside your library
752752
753753
<p></p>
754754
755-
**Initialize the Branch SDK**
755+
#### Initialize the Branch SDK
756756
757757
Open your `main.dart` file in FlutterFlow and add the `initBranch` custom action under the **Final Actions** section. This ensures the **Branch SDK** is initialized when your app launches.
758758
759+
<div style={{
760+
position: 'relative',
761+
paddingBottom: 'calc(56.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding
762+
height: 0,
763+
width: '100%'
764+
}}>
765+
<iframe
766+
src="https://demo.arcade.software/sAGP2IBXMbHMPP4rXRaQ?embed&show_copy_link=true"
767+
title=""
768+
style={{
769+
position: 'absolute',
770+
top: 0,
771+
left: 0,
772+
width: '100%',
773+
height: '100%',
774+
colorScheme: 'light'
775+
}}
776+
frameborder="0"
777+
loading="lazy"
778+
webkitAllowFullScreen
779+
mozAllowFullScreen
780+
allowFullScreen
781+
allow="clipboard-write">
782+
</iframe>
783+
</div>
784+
759785
760786
### Handle Branch Deeplink [Custom Action]
761787
@@ -847,11 +873,11 @@ Use the link data from this callback to:
847873
- Load content from Firestore using a referenced ID.
848874
849875
850-
:::danger[Testing Deeplinks]
851-
It’s recommended to test deep links on a **physical device**, as link verification (especially for Universal Links or App Links) may not consistently work on emulators or simulators.
852-
:::
853876
854877
878+
:::danger[Testing Deeplinks]
879+
It’s recommended to test deep links on a **physical device**, as link verification (especially for Universal Links or App Links) may not consistently work on emulators or simulators. We recommend using **[Local Run](../../testing-deployment-publishing/running-your-app/local-run.md)** to run your apps on physical devices.
880+
:::
855881
856882
857883
### Generate Link [Custom Action]
@@ -873,11 +899,17 @@ The action accepts the following parameters:
873899
- **`description`** – (Optional) A short description of the content.
874900
875901
- **`metadata`** – A dynamic map of custom parameters to include with the link
876-
(e.g., page: "imageDetails", imageRef: "abc123", etc.)
902+
(e.g., page: "imageDetails", imageRef: "abc123", etc.).
877903
878904
- **`linkProperties`** – A dynamic map for configuring how the link behaves
879905
(e.g., set the `feature`, `channel`, `campaign`, or `stage` for analytics).
880906
907+
:::warning[JSON maps]
908+
Due to a limitation, if you plan to leave map-type variables (like `metadata` or `linkProperties`) empty, you must still pass them as **empty maps**, not `null`.
909+
Ensure all keys and values are **plain strings**, avoid nested JSON or non-string types.
910+
Incorrect structure may cause the Link Generation action to fail silently.
911+
:::
912+
881913
### Branch Helper Functions
882914
883915
These functions help you safely work with deep link data, extract values, and conditionally navigate based on link metadata.

0 commit comments

Comments
 (0)