Skip to content

Update deep link docs due to the flutter_deeplinking_enabled flag default value change. #11461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
16 changes: 9 additions & 7 deletions src/content/cookbook/navigation/set-up-app-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ It provides a simple API to handle complex routing scenarios.
Replace `example.com` with your own web domain.

```xml
<meta-data android:name="flutter_deeplinking_enabled" android:value="true" />
<intent-filter android:autoVerify="true">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
Expand All @@ -99,12 +98,15 @@ It provides a simple API to handle complex routing scenarios.
```

:::note
The metadata tag `flutter_deeplinking_enabled` opts
into Flutter's default deeplink handler.
If you are using the third-party plugins,
such as [app_links][], setting this metadata tag will
break these plugins. Omit this metadata tag
if you prefer to use third-party plugins.
If you use a third-party plugin to handle deep links,
such as [app_links][],
Flutter's default deeplink handler will
break these plugins.

To opt out of using Flutter's default deep link handler,
add the following metadata tag:
```<meta-data android:name="flutter_deeplinking_enabled" android:value="false" />```
to opt out of Flutter's default deeplink handler
:::

## 3. Hosting assetlinks.json file
Expand Down
43 changes: 9 additions & 34 deletions src/content/cookbook/navigation/set-up-universal-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,40 +82,15 @@ It provides a simple API to handle complex routing scenarios.
1. Open the `ios/Runner.xcworkspace` file inside the
Flutter project's `ios` folder.

### Add the FlutterDeepLinkingEnabled key value pair

1. In the Xcode Navigator, expand **Runner** then click **Info**.

<img src="/assets/images/docs/cookbook/set-up-universal-links-info-plist.png"
alt="Xcode info.Plist screenshot"
width="100%" />

1. In the Editor, <kbd>Ctrl</kbd> + click and
select **Raw Keys and Values** from the context menu.

1. In the Editor, <kbd>Ctrl</kbd> + click and
select **Add Row** from the context menu.

A new **Key** should display.

1. Change the new key properties to meet the following:

* Change the **Key** to `FlutterDeepLinkingEnabled`
* Change the **Type** to `Boolean`
* Change the **Value** to `YES`.

<img
src="/assets/images/docs/cookbook/set-up-universal-links-flutterdeeplinkingenabled.png"
alt="Screenshot of FlutterDeepLinkingEnabled value set to YES."
width="100%" />

:::note
The `FlutterDeepLinkingEnabled` property enables
Flutter's default deeplink handler.
If you use a third-party plugin, such as [app_links][],
setting this property breaks the third-party plugin.
Skip this step if you prefer to use a third-party plugin.
:::
:::note
If you are use a third-party plugins to handle deep links,
such as [app_links][],
Flutter's default deeplink handler will
break these plugins.

If you use a third-party plugin,
add the key and value pair `FlutterDeepLinkingEnabled` and `NO` to info.Plist.
:::

### Add associated domains

Expand Down
6 changes: 3 additions & 3 deletions src/content/ui/navigation/deep-linking.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ To get started, see our cookbooks for Android and iOS:
If you have written a plugin to handle deep links, as described in
[Deep Links and Flutter applications][plugin-linking]
(a free article on Medium),
it will continue to work until you opt in to this behavior by adding
`FlutterDeepLinkingEnabled` to `Info.plist` or
`flutter_deeplinking_enabled` to `AndroidManifest.xml`, respectively.
you should opt out the Flutter's default deep link handler.
To do this, set `FlutterDeepLinkingEnabled` to false in `Info.plist` _or_
`flutter_deeplinking_enabled` to false in `AndroidManifest.xml`.

## Behavior

Expand Down
Loading