Deeplinks
This plugin handles deeplinks on iOS and Android for both custom URL scheme links and Universal App Links.
Stuck on a Cordova issue?
If you're building a serious project, you can't afford to spend hours troubleshooting. Ionic's experts offer official maintenance, support, and integration help.
Installation
Ionic EE comes with fully supported and maintained plugins from the Ionic Team. Learn More or Contact Us
Supported Platforms
- Android
- Browser
- iOS
Usage
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.