Skip to content

Commit 7b48072

Browse files
Apply suggestions from code review
Co-authored-by: pinkeshmars <[email protected]>
1 parent 3009e91 commit 7b48072

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -700,11 +700,11 @@ To add it to a specific project, go to **Settings > Project Dependencies**, clic
700700
701701
You’ll need three values from your Branch dashboard:
702702
703-
- **Branch Key** – your production or test key from the Branch dashboard.
703+
- **Branch Key**: Your production or test key from the Branch dashboard.
704704
705-
- **Custom Link Domain** – your primary Branch link domain (e.g., yourapp.app.link). This is used to generate and handle smart links.
705+
- **Custom Link Domain**: Your primary Branch link domain (e.g., yourapp.app.link). This is used to generate and handle smart links.
706706
707-
- **Alternate Link Domain** – an additional Branch domain (e.g., yourapp-alternate.app.link) that points to the same link data and behavior.
707+
- **Alternate Link Domain**: An additional Branch domain (e.g., yourapp-alternate.app.link) that points to the same link data and behavior.
708708
This is recommended for ensuring better deliverability across platforms and channels, and must be included in your platform configuration.
709709
710710
We recommend storing these values in Environment Variables so you can:
@@ -832,7 +832,7 @@ The `handleBranchDeeplink` action receives a `linkData` object that contains all
832832
833833
In the Dreambrush app example, we get the following link data:
834834
835-
```json
835+
```jsx
836836
{
837837
"$og_title": "Check out my Ai Image on DreamBrush!",
838838
"$publicly_indexable": true,
@@ -873,7 +873,7 @@ Some of the important keys we should know about:
873873
874874
- **`page`:** This is a suggested custom key that can be set by the user when generating the link. It typically defines the target page or screen the app should navigate to when the link is opened (e.g., "paywall", "productPage", "onboardingStep2"). While not a reserved Branch key, it's a commonly used naming convention for handling deep links and routing logic within the app.
875875
876-
- Any other custom parameters added during link creation (e.g., `productId`, `referrer`, etc.). Ensure the key and value is both `String` and `String`.
876+
- Any other custom parameters added during link creation (e.g., `productId`, `referrer`, etc.). Ensure the key and value are both `String`.
877877
878878
This lets you write flexible, conditional navigation logic based on what was shared. For example, in the following example, we can even show a bottom sheet based on the page value.
879879
@@ -962,19 +962,19 @@ These functions help you safely work with deep link data, extract values, and co
962962
963963
- **`isTargetingPage(linkData, targetPage)`** - Checks whether the page value in the link data matches a specific screen name. The `page` parameter is set by the user when generating the link from Branch dashboard or FlutterFlow. For example, if the target page value in your deep link is "paywall", you can use this function to check for this value and navigate accordingly.
964964
965-
- **`getCanonicalIdentifierFromLink(linkData)`** - Helper function that returns the canonical path (e.g., `/imageDetails/abc123`) that was originally attached to the smart link. Useful for extracting the base route or content reference associated with the shared link.
965+
- **`getCanonicalIdentifierFromLink(linkData)`**: Helper function that returns the canonical path (e.g., `/imageDetails/abc123`) that was originally attached to the smart link. Useful for extracting the base route or content reference associated with the shared link.
966966
967-
- **`getReferringLinkFromLink(linkData)`** - Helper function that retrieves the full Branch smart link URL from the data (typically under the `~referring_link` key). Useful for tracking, analytics, or verifying the source of the link.
967+
- **`getReferringLinkFromLink(linkData)`**: Helper function that retrieves the full Branch smart link URL from the data (typically under the `~referring_link` key). Useful for tracking, analytics, or verifying the source of the link.
968968
969-
- **`getLastPathSegmentFromMap(linkData, key)`** - Extracts the last path segment (e.g., `abc123`) from a URI stored inside a link data field (e.g., `/imageDetails/abc123`). This is especially useful when your deep link contains a structured path, like `/imageDetails/abc123` and you want to retrieve just the ID (`abc123`).
969+
- **`getLastPathSegmentFromMap(linkData, key)`**: Extracts the last path segment (e.g., `abc123`) from a URI stored inside a link data field (e.g., `/imageDetails/abc123`). This is especially useful when your deep link contains a structured path, like `/imageDetails/abc123` and you want to retrieve just the ID (`abc123`).
970970
971-
- **`getLinkValue(linkData, key)`** - Safely retrieves any single value from the link data Map. Returns null if not found. (e.g., retrieving `showPromo` attribute value from the `linkData`).
971+
- **`getLinkValue(linkData, key)`**: Safely retrieves any single value from the link data Map. Returns null if not found. (e.g., retrieving `showPromo` attribute value from the `linkData`).
972972
973973
:::warning
974974
If you're trying to retrieve default Branch keys like `~channel` or `$canonical_identifier`, make sure to include the special character (e.g., `~` or `$`) as part of the key string.
975975
:::
976976
977-
- **`createLinkProperties(...)`** - Returns a Branch Link Properties map used when generating a smart link. You can define values like: feature, campaign, stage, channel, alias or tags or custom fallback URLs. Useful for organizing and tracking generated links for marketing or referrals.
977+
- **`createLinkProperties(...)`**: Returns a Branch Link Properties map used when generating a smart link. You can define values like: feature, campaign, stage, channel, alias or tags or custom fallback URLs. Useful for organizing and tracking generated links for marketing or referrals.
978978
979979
980980
@@ -1051,7 +1051,7 @@ Now in your `handleBranchDeeplink` action callback, add the additional logic to
10511051
10521052
To demonstrate how to use the global context for navigation, add a new **Execute Custom Code** Action just before the **Navigate To** Action, and insert the following code.
10531053
1054-
```js
1054+
```jsx
10551055
final context = appNavigatorKey.currentContext!;
10561056
```
10571057

0 commit comments

Comments
 (0)