Deeplinks
This plugin handles deeplinks on iOS and Android for both custom URL scheme links and Universal App Links.
Please read the ionic plugin deeplinks docs for iOS and Android integration.
You must add
universal-links to your
config.xml and set up Apple App Site Association (AASA) for iOS and Asset Links for Android.
Premier Version Available
Featuring regular release cycles, security and bug fixes, and guaranteed SLAs.
Installation
Ionic Enterprise comes with fully supported and maintained plugins from the Ionic Team. Learn More or if you're interested in an enterprise version of this plugin Contact Us
Supported Platforms
- Android
- Browser
- iOS
Usage
Using React?
import { Deeplinks } from '@ionic-native/deeplinks/ngx';
constructor(private deeplinks: Deeplinks) { }
this.deeplinks.route({
'/about-us': AboutPage,
'/universal-links-test': AboutPage,
'/products/:productId': ProductPage
}).subscribe(match => {
// match.$route - the route we matched, which is the matched entry from the arguments to route()
// match.$args - the args passed in the link
// match.$link - the full link data
console.log('Successfully matched route', match);
}, nomatch => {
// nomatch.$link - the full link data
console.error('Got a deeplink that didn\'t match', nomatch);
});Alternatively, if you're using Ionic, there's a convenience method that takes a reference to a
NavController and handles
the actual navigation for you:
this.deeplinks.routeWithNavController(this.navController, {
'/about-us': AboutPage,
'/products/:productId': ProductPage
}).subscribe(match => {
// match.$route - the route we matched, which is the matched entry from the arguments to route()
// match.$args - the args passed in the link
// match.$link - the full link data
console.log('Successfully matched route', match);
}, nomatch => {
// nomatch.$link - the full link data
console.error('Got a deeplink that didn\'t match', nomatch);
});See the Ionic Deeplinks Demo for an example of how to
retrieve the
NavController reference at runtime.