@iamdew/deep-link

Redirecting native iOS/Android App from your Website using app scheme.

Stats

StarsIssuesVersionUpdatedCreatedSize
@iamdew/deep-link
1611.1.14 years ago4 years agoMinified + gzip package size for @iamdew/deep-link in KB

Readme

deep-link.js

NPM Version NPM Downloads Build Status Test Coverage

šŸŒˆ Redirecting native iOS/Android App from your Website using app scheme.

Usage

1. Include deep-link.js on your site.

Using CDN

<script src="https://cdn.jsdelivr.net/npm/@iamdew/deep-link@latest/dist/deep-link.min.js"></script>

Using Bower

bower install --save deep-link

<script src="./bower_components/deep-link/dist/deep-link.min.js"></script>

Using NPM

npm install --save @iamdew/deep-link

import DeepLink from '@iamdew/deep-link';

2. Initialize deep-link.js related by your app infomation.

var deepLink = new DeepLink({
  appStore: 'https://itunes.apple.com/kr/app/id123456789',
  playStore: 'https://play.google.com/store/apps/details?id=com.example.myApp',
});

2-1. Register click event

deepLink.register(document.getElementById('test'), {
  appScheme: 'myApp://example/51', // Required (Optional that if openOnlyStore is true)
  webUrl: 'http://www.naver.com', // Optional
  openOnlyStore: true, // Optional (Default: false)
  alsoUseWebUrlOnMobile: false, // Optional (Default: true)
  openStoreWhenNoInstalledTheApp: false, // Optional (Default: true)
});

2-2. Manual Open the Application

deepLink.openApp({
  appScheme: 'myApp://example/51', // Required
  webUrl: 'http://www.naver.com', // Optional
  alsoUseWebUrlOnMobile: false, // Optional (Default: true)
  openStoreWhenNoInstalledTheApp: false, // Optional (Default: true)
});

2-3. Just Open the Store

deepLink.openStore();

Issues

Feel free to submit issues and enhancement requests.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/flosdor/deep-link

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

MIT LICENSE

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.