Need help with browser-deeplink?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

hampusohlsson
442 Stars 167 Forks MIT License 20 Commits 17 Opened issues

Description

Redirect mobile website users to your native iOS and/or Android app

Services available

!
?

Need anything else?

Contributors list

# 185,481
HTML
React
flexbox
javascr...
11 commits
# 141,129
Swift
socket-...
carthag...
swift-3
2 commits
# 91,263
PHP
Dart
yarn
Compose...
1 commit
# 18,178
Swift
golang
swift-p...
Xcode
1 commit
# 349,085
JavaScr...
HTML
amazon
Webpack
1 commit

browser-deeplink

‼️ Not maintained - Use at own risk

Redirect your website users to your native Android and/or iOS app. If the user does not have the app, they are redirected to the corresponding app store page.

Such functionality is very common for apps like YouTube, Spotify etc. But it is not default functionality in mobile browsers today, and unnecessarily hard to implement. This plugin uses a workaround with a hidden

iframe
and
setTimeout()
.

How to use

1. Include browser-deeplink on your site.


or

require("./browser-deeplink");

2. Provide your app details

deeplink.setup({
    iOS: {
        appName: "myapp",
        appId: "123456789",
    },
    android: {
        appId: "com.myapp.android"
    }
});

This will create the following fallback app store links:

iOS:

itms-apps://itunes.apple.com/app/myapp/id123456789?mt=8

Android:
https://play.google.com/store/apps/details?id=com.myapp.android

Options

Optionally, you can specify a

iOS.storeUrl
or
android.storeUrl
to override the fallback redirect.
js
deeplink.setup({
    iOS: {
        storeUrl: "http://...",
    }
});

You can also skip the app store fallback altogether if you want by specifying

fallback: false
js
deeplink.setup({
    fallback: false
});

In case you want to register your android app on your http(s) links directly you can disable deeplinking for android by specifying

androidDisabled: true
js
deeplink.setup({
    androidDisabled: true
});

3. Open your deeplinks!

window.onload = function() {
    deeplink.open("myapp://object/xyz");
}

License

This library is released under the MIT licence.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.