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: about 2 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 (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T13:48:24.000Z (4 months ago)
• Last Synced: 2024-09-13T01:52:24.113Z (4 months ago)
• Language: C++
• Homepage: https://pub.dev/packages/app_links
• Size: 480 KB
• Stars: 194
• Watchers: 3
• Forks: 75
• Open Issues: 4
• 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 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.

* [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)

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.