Migrate protocol_handler's custom protocol and deep-link capabilities to NativeAPI

Offen
  • Stimmt etwas nicht?
#27 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
dart, flutter, typescript
Bereich
api, desktop

Rechercherichtung

Start with the linked protocol_handler README and public API references to map the existing registration, launch URL, event, and listener behavior. Then inspect NativeAPI's UrlOpener and its Dart/Flutter bindings and platform integrations. Done means equivalent APIs, setup documentation and a migration example cover Android, iOS, macOS, and Windows, with the listed scenarios validated on each.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Goal

Bring the full public capability set of protocol_handler into NativeAPI so Flutter apps can migrate without losing functionality.

Scope

Provide equivalents for:

  • register(String scheme) for custom protocol registration/configuration.
  • getInitialUrl() for retrieving the URL that launched the app.
  • onUrlReceived for incoming URL events.
  • ProtocolListener.onProtocolUrlReceived(String url), listener attachment/removal, and listeners / hasListeners inspection.

API names may change, but the migration guide should map every existing public capability to its NativeAPI equivalent.

Platform coverage

Match the source plugin's documented support: Android, iOS, macOS and Windows. Document the required Android intent filters, iOS/macOS URL scheme declarations, Windows runner integration and MSIX protocol activation configuration.

Acceptance criteria
  • Expose equivalent APIs to Dart/Flutter.
  • Document platform support, setup requirements and limitations.
  • Provide a migration guide and example covering registration, launch URLs, incoming events and listener cleanup.
  • Validate these scenarios on all four source-supported platforms.
Notes

NativeAPI's existing UrlOpener handles outbound URLs, not incoming protocol activations. The source plugin exposes no unregister API, so unregistration is not assumed to be part of migration parity. Linux support and other language bindings can be scoped separately.

References
Vorherrschende Sprache
TypeScript
Sterne
172
Forks
16
Ø Merge
40 Min.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus libnativeapi/nativeapi

Alle Issues in libnativeapi/nativeapi

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.