Skip to content

Android App Links, Deep Links, iOs Universal Links and Custom URL schemes handler for Flutter.

License

Notifications You must be signed in to change notification settings

llfbandit/app_links

Repository files navigation

app_links

Android App Links, Deep Links, iOS Universal Links and Custom URL schemes handler (desktop included linux, macOS, Windows).

This plugin allows you to open your app from:

  • HTTPS URLs instead of the browser.
  • custom schemes.

Getting Started

Before using the plugin, you'll need to setup each platform you target.

All those configurations below are also accessible in the example project.


AppLinks usage

Please, ensure to instantiate AppLinks early in your app to catch the very first link when the app is in cold state.

final appLinks = AppLinks(); // AppLinks is singleton

// Subscribe to all events (initial link and further)
final sub = appLinks.uriLinkStream.listen((uri) {
    // Do something (navigation, ...)
});

Feature matrix

Feature Android iOS web Windows macOS linux
web (https://) ✔️ ✔️ ✔️* ✔️ ✔️ ?
custom scheme (foo://) ✔️ ✔️ ✔️ ✔️ ✔️

* : Only the very first call is provided. Web platform is mostly provided to get rid of specific setup.