protocol_handlers
Type | Array |
---|---|
Mandatory | No |
Example |
|
Use this key to register one or more web-based protocol handlers.
A protocol handler is an application that knows how to handle particular types of links: for example, a mail client is a protocol handler for "mailto:" links. When the user clicks a "mailto:" link, the browser opens the application selected as the handler for the "mailto:" protocol (or offers them a choice of handlers, depending on their settings).
With this key, you can register a website as a handler for a particular protocol. The syntax and semantics of this key is very much like the Navigator.registerProtocolHandler()
function, except that with registerProtocolHandler()
a website can only register itself as a handler.
Each protocol handler has three properties, all mandatory:
protocol
-
A string defining the protocol. This must be either:
- one of the following: "bitcoin", "dat", "dweb", "ftp", "geo", "gopher", "im", "ipfs", "ipns", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "sip", "sms", "smsto", "ssb", "ssh", "tel", "urn", "webcal", "wtai", "xmpp".
- a string consisting of a custom name prefixed with "web+" or "ext+". For example: "web+foo" or "ext+foo". The custom name must consist only of lower-case ASCII characters. It's recommended that extensions use the "ext+" form.
name
- A string representing the name of the protocol handler. This will be displayed to the user when they are being asked if they want this handler to open the link.
uriTemplate
- A string representing the URL of the handler. This string must include "%s" as a placeholder: this will be replaced with the escaped URL of the document to be handled. This URL might be a true URL, or it could be a phone number, email address, or so forth. This is a localizable property.
Example
"protocol_handlers": [
{
"protocol": "magnet",
"name": "Magnet Extension",
"uriTemplate": "https://example.com/#!/%s"
}
]
If the protocol is not in the allowed list then it has to start with 'ext+'
"protocol_handlers": [
{
"protocol": "ext+foo",
"name": "Foo Extension",
"uriTemplate": "https://example.com/#!/%s"
}
]
Handlers can also be extension pages.
"protocol_handlers": [
{
"protocol": "magnet",
"name": "Magnet Extension",
"uriTemplate": "/example.xhtml#!/%s"
}
]
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
protocol_handlers | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support54 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support54 |
dat | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
dweb | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
ftp | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support88 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support88 |
gopher | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support56 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support56 |
ipfs | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
ipns | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
ssb | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
Legend
- Full support
- Full support
- No support
- No support