2019-11-13 05:46:54 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
2021-07-08 11:42:28 -07:00
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP -->
|
|
|
|
|
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
|
|
|
|
|
<meta http-equiv="X-Content-Security-Policy" content="default-src 'self'; script-src 'self'">
|
|
|
|
|
<title>app.setAsDefaultProtocol Demo</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
2019-11-13 05:46:54 +00:00
|
|
|
<body>
|
2021-07-08 11:42:28 -07:00
|
|
|
<h1>App Default Protocol Demo</h1>
|
|
|
|
|
|
|
|
|
|
<p>The protocol API allows us to register a custom protocol and intercept existing protocol requests.</p>
|
|
|
|
|
<p>These methods allow you to set and unset the protocols your app should be the default app for. Similar to when a
|
|
|
|
|
browser asks to be your default for viewing web pages.</p>
|
|
|
|
|
|
2023-08-10 11:55:52 +02:00
|
|
|
<p>Open the <a href="https://www.electronjs.org/docs/latest/api/protocol">full protocol API documentation</a> in your
|
2021-07-08 11:42:28 -07:00
|
|
|
browser.</p>
|
|
|
|
|
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
<h3>Demo</h3>
|
|
|
|
|
<p>
|
|
|
|
|
First: Launch current page in browser
|
|
|
|
|
<button id="open-in-browser" class="js-container-target demo-toggle-button">
|
|
|
|
|
Click to Launch Browser
|
|
|
|
|
</button>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Then: Launch the app from a web link!
|
|
|
|
|
<a href="electron-fiddle://open">Click here to launch the app</a>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
----
|
2019-11-13 05:46:54 +00:00
|
|
|
|
2021-07-08 11:42:28 -07:00
|
|
|
<p>You can set your app as the default app to open for a specific protocol. For instance, in this demo we set this app
|
|
|
|
|
as the default for <code>electron-fiddle://</code>. The demo button above will launch a page in your default
|
|
|
|
|
browser with a link. Click that link and it will re-launch this app.</p>
|
2019-11-13 05:46:54 +00:00
|
|
|
|
|
|
|
|
|
2021-07-08 11:42:28 -07:00
|
|
|
<h3>Packaging</h3>
|
|
|
|
|
<p>This feature will only work on macOS when your app is packaged. It will not work when you're launching it in
|
|
|
|
|
development from the command-line. When you package your app you'll need to make sure the macOS <code>plist</code>
|
2023-11-09 11:15:32 -08:00
|
|
|
for the app is updated to include the new protocol handler. If you're using <code>@electron/packager</code> then you
|
2021-07-08 11:42:28 -07:00
|
|
|
can add the flag <code>--extend-info</code> with a path to the <code>plist</code> you've created. The one for this
|
|
|
|
|
app is below:</p>
|
2019-11-13 05:46:54 +00:00
|
|
|
|
2021-07-08 11:42:28 -07:00
|
|
|
<p>
|
|
|
|
|
<h5>macOS plist</h5>
|
|
|
|
|
<pre><code>
|
|
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
|
|
|
<plist version="1.0">
|
|
|
|
|
<dict>
|
|
|
|
|
<key>CFBundleURLTypes</key>
|
|
|
|
|
<array>
|
|
|
|
|
<dict>
|
|
|
|
|
<key>CFBundleURLSchemes</key>
|
|
|
|
|
<array>
|
|
|
|
|
<string>electron-api-demos</string>
|
|
|
|
|
</array>
|
|
|
|
|
<key>CFBundleURLName</key>
|
|
|
|
|
<string>Electron API Demos Protocol</string>
|
|
|
|
|
</dict>
|
|
|
|
|
</array>
|
|
|
|
|
<key>ElectronTeamID</key>
|
|
|
|
|
<string>VEKTX9H2N7</string>
|
|
|
|
|
</dict>
|
|
|
|
|
</plist>
|
|
|
|
|
</code>
|
|
|
|
|
</pre>
|
|
|
|
|
<p>
|
2019-11-13 05:46:54 +00:00
|
|
|
|
2021-07-08 11:42:28 -07:00
|
|
|
<!-- You can also require other files to run in this process -->
|
|
|
|
|
<script src="./renderer.js"></script>
|
2019-11-13 05:46:54 +00:00
|
|
|
</body>
|
|
|
|
|
|
2021-07-08 11:42:28 -07:00
|
|
|
</html>
|
