https://github.com/llfbandit/app_links

Android App Links, Deep Links, iOs Universal Links and Custom URL schemes handler for Flutter.
https://github.com/llfbandit/app_links

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/llfbandit/app_links
• Owner: llfbandit
• License: apache-2.0
• Created: 2020-11-26T13:26:14.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-03T00:05:48.000Z (3 months ago)
• Last Synced: 2024-08-03T01:13:10.417Z (3 months ago)
• Language: C++
• Homepage: https://pub.dev/packages/app_links
• Size: 451 KB
• Stars: 180
• Watchers: 3
• Forks: 72
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-flutter-desktop - app_links - Android App Links, Deep Links, iOs Universal Links and Custom URL schemes handler for Flutter (desktop included). (Packages)

README

        
# 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:

- catch HTTPS URLs to open your app instead of the browser (App Link / Universal Link).

- catch custom schemes to open your app (Deep Link / Custom URL scheme).

## 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.

* [Android](https://github.com/llfbandit/app_links/blob/master/doc/README_android.md)

* [iOS](https://github.com/llfbandit/app_links/blob/master/doc/README_ios.md)

* [Linux](https://github.com/llfbandit/app_links/blob/master/doc/README_linux.md)

* [macOS](https://github.com/llfbandit/app_links/blob/master/doc/README_macos.md)

* [Windows](https://github.com/llfbandit/app_links/blob/master/doc/README_windows.md)

* There's nothing to setup for web platform. Only the initial link is provided.

---

### AppLinks usage

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

```dart

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

// Subscribe to all events (initial link and further)

_appLinks.uriLinkStream.listen((uri) {

    // Do something (navigation, ...)

});

```