Skip to content

vireshshah/custom-protocol-check

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
This branch is 14 commits ahead, 1 commit behind ismailhabib:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Custom Protocol Check in Browser

Build StatusDependency Status NPM version Pull requests GitHub license

Detect whether a custom protocol is available in browser (Chrome, Firefox, Safari, iOS, IE8-IE11 and Edge)

The implementation is different from one browser to another, sometimes depend on which OS you are. Most of them are hacks, meaning that the solution is not the prettiest.

Important feature: If current tab is not active when it's trying to detect focus then it would attempt to open protocol as soon as focus is back on current tab. It is more useful when there is a long running process and at the end of that process we need to detect whether that file can be opened using custom protocol. User might be doing his work on different tabs or applications so in such cases library would try to detect custom protocol as soon as current tab gets focus.

  • Chrome and iOS: using window onBlur to detect whether the focus is stolen from the browser. When the focus is stolen, it assumes that the custom protocol launches external app and therefore it exists.
  • Firefox (Version >= 64): using hidden iframe onBlur to detect whether the focus is stolen. When the focus is stolen, it assumes that the custom protocol launches external app and therefore it exists.
  • Firefox (Version < 64): try to open the handler in a hidden iframe and catch exception if the custom protocol is not available.
  • Safari: using hidden iframe onBlur to detect whether the focus is stolen. When the focus is stolen, it assumes that the custom protocol launches external app and therefore it exists.
  • IEs and Edge in Win 8/Win 10: the cleanest solution. IEs and Edge in Windows 8 and Windows 10 does provide an API to check the existence of custom protocol handlers. Other older IE versions are not supported.

Examples

import customProtocolCheck from "custom-protocol-check";

customProtocolCheck(
  "mycustomprotocol://params",
  () => {
    console.log("Custom protocol not found.");
  },
  () => {
    console.log("Custom protocol found and opened the file successfully.");
  }, 5000
);

Options

  • uri: Custom protocol url to check for.
  • failCb: Callback function which gets called when custom protocol not found.
  • successCb: Callback function which gets called when custom protocol is found.
  • timeout: (default: 2000) Timeout in milliseconds. It waits for timeout unless it calls failCb. If protocol already exists then it would try to open the app right away. Note: Sometimes app associated with custom protocol might take time to open up and this solution rely on blur event, so adjust this setting as per your app's first screen loading time to prevent failCb getting called.
  • unsupportedCb: Callback function which gets called when browser is not supported.

Known Issues

  • In some protocol such as "mailto:", IE seems to trigger the fail callback while continuing on opening the protocol just fine (tested in IE11/Win 10). This issue doesn't occur with a custom protocol.

Special Thanks

custom-protocol-check is forked from https://github.com/ismailhabib/custom-protocol-detection. Many thanks to Ismail Habib Muhammad.

Happy Coding! Viresh Shah (http://www.vireshshah.com)

About

Detect whether a custom protocol is available in browser (FF, Chrome, IE8, IE9, IE10, IE11, and Edge)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%