Deep linking
Deep links are links that not only open an app, but also take the user to a specific location "deep" inside the app. For example, a deep link from an advertisement for a pair of sneakers might open a shopping app and display the product page for those particular shoes.
Flutter supports deep linking on iOS, Android, and the web. Opening a URL displays that screen in your app. With the following steps, you can launch and display routes by using named routes (either with the routes parameter or onGenerateRoute), or by using the Router widget.
If you're running the app in a web browser, there's no additional setup required. Route paths are handled in the same way as an iOS or Android deep link. By default, web apps read the deep link path from the url fragment using the pattern: /#/path/to/app/screen, but this can be changed by configuring the URL strategy for your app.
If you are a visual learner, check out the following video:
Get started
#To get started, see our cookbooks for Android and iOS:
Migrating from plugin-based deep linking
#If you have written a plugin to handle deep links, as described in Deep Links and Flutter applications (a free article on Medium), 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
#The behavior varies slightly based on the platform and whether the app is launched and running.
| Platform / Scenario | Using Navigator | Using Router |
|---|---|---|
| iOS (not launched) | App gets initialRoute ("/") and a short time after gets a pushRoute | App gets initialRoute ("/") and a short time after uses the RouteInformationParser to parse the route and call RouterDelegate.setNewRoutePath, which configures the Navigator with the corresponding Page. |
| Android - (not launched) | App gets initialRoute containing the route ("/deeplink") | App gets initialRoute ("/deeplink") and passes it to the RouteInformationParser to parse the route and call RouterDelegate.setNewRoutePath, which configures the Navigator with the corresponding Pages. |
| iOS (launched) | pushRoute is called | Path is parsed, and the Navigator is configured with a new set of Pages. |
| Android (launched) | pushRoute is called | Path is parsed, and the Navigator is configured with a new set of Pages. |
When using the Router widget, your app has the ability to replace the current set of pages when a new deep link is opened while the app is running.
To learn more
#- Learning Flutter's new navigation and routing system provides an introduction to the Router system.
- Deep dive into Flutter deep linking video from Google I/O 2023
- Flutter Deep Linking: The Ultimate Guide, a step-by-step tutorial showing how to implement deep links in Flutter.
Unless stated otherwise, the documentation on this site reflects the latest stable version of Flutter. Page last updated on 2024-12-04. View source or report an issue.