deep_links_kit.dart

deep_links_kit library

Router-agnostic handling of Android App Links, iOS Universal Links and custom URL schemes.

Native setup lives in the CLI: dart run deep_links_kit setup.

Classes

AppLinksSource: The default source, backed by the app_links plugin.
DeepLink: An incoming link, normalized so web links and custom-scheme links can be matched by the same route patterns.
DeepLinkMatch: The result of matching a DeepLink against a route pattern.
DeepLinkNavigator: Opens a resolved in-app path. Plug in any router through this interface.
DeepLinkRoute: Maps a link pattern to an in-app path.
DeepLinksKit: Receives App Links, Universal Links and custom-scheme links, waits until the app is ready, and opens the matching in-app path.
DeepLinkSource: Where incoming links come from. Replace it in tests or to feed links from another plugin.
DeepLinkTarget: Where a link leads inside the app.

DeepLinkErrorHandler = void Function(Object error, StackTrace stack): Receives errors thrown while handling links.
DeepLinkFallback = String? Function(DeepLink link): Builds the path for links no route matched, or returns null to ignore.
DeepLinkListener = void Function(DeepLink link, DeepLinkTarget? to): Called for every received link with the target it resolved to, or null when it was ignored.
DeepLinkResolver = String? Function(DeepLinkMatch match): Builds the in-app path for a matched link, or returns null to let the next route try.