Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glawson/electron-deeplink
Node module for Electron apps that sets the default handler for a given protocol (deep links) in both development and production environments.
https://github.com/glawson/electron-deeplink
electronjs macos nodejs
Last synced: about 3 hours ago
JSON representation
Node module for Electron apps that sets the default handler for a given protocol (deep links) in both development and production environments.
- Host: GitHub
- URL: https://github.com/glawson/electron-deeplink
- Owner: glawson
- Created: 2020-08-10T17:24:36.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-10T19:15:10.000Z (11 months ago)
- Last Synced: 2024-09-19T15:25:35.034Z (5 days ago)
- Topics: electronjs, macos, nodejs
- Language: TypeScript
- Homepage: https://github.com/glawson/electron-deeplink
- Size: 189 KB
- Stars: 52
- Watchers: 4
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://lbesson.mit-license.org/)
[](https://circleci.com/gh/glawson/electron-deeplink)
# 🚨 Deprecation Notice 🚨
The bad news; due to a lack of time and, unfortunitly, no longer directly working with Electrion, I need to deprecate this package.
The good news; @witcher112 has picked up the pieces, and created a better protocol package.
You can find it at: [electron-app-universal-protocol-client](https://github.com/witcher112/electron-app-universal-protocol-client)
# electron-deeplink
Node module for Electron apps that sets the default handler for a given protocol (deep links) in both
development and production environments.
This module was inspired due to the lack of protocol support when running non packaged apps on macOS (see [`app.setAsDefaultProtocolClient`](https://www.electronjs.org/docs/api/app#appsetasdefaultprotocolclientprotocol-path-args) for explanation). This module provides full support for running and testing the given protocol in the development environment. It also provides the same protocol support for the production envronment. In other words, protocol management is completly controlled with this module.
# Please Note
- For Production: While electron-deeplink handles setting `app.setAsDefaultProtocolClient`, you still need to make sure setup the mac bundleId correctly for [electron-builder](https://www.electron.build/configuration/configuration) or [electron-forge](https://www.electronforge.io/configuration).
# Example App
A full working example can be found [here](https://github.com/glawson/electron-deeplink-example)
# Installation
```sh
# If you use npm:
npm install electron-deeplink
# If you use yarn:
$ yarn add electron-deeplink
```
# Usage
In `main.js`, include the `electron-deeplink` module and instantiate the Deeplink class towards to begining of `main.js`.
```js
// main.js
const { app, BrowserWindow } = require('electron');
const { Deeplink } = require('electron-deeplink');
const isDev = require('electron-is-dev');
let mainWindow;
const protocol = isDev ? 'dev-app' : 'prod-app';
const deeplink = new Deeplink({ app, mainWindow, protocol, isDev });
```
Setup a watch on the deeplink 'received' event
```js
// main.js
deeplink.on('received', (link) => {
// do stuff here
});
```
# API
## creating an instance
```js
const deeplink = new Deeplink([config]);
```
## config
```ts
{
// required
// type: electron app
app: [electron.app]
// required
// type: app.BrowserWindow
// Reference to the apps main window
mainWindow: [main window reference]
// required
// type: string
// String representing the protocol to use. For production, this should be the same as the bundleId set in the build config.
protocol: [protocol string]
// optional, default: false
// type: boolean
// Represents the app environment
isDev: boolean
// optional, default: false
// type: boolean
// If true, outputs logging. Uses electron-log, so files are appened/created for prod.
debugLogging: boolean
// optional, default: '/node_modules/electron/dist/Electron.app'
// type: string
// String representing the location of Electron relative to the app root.
electronPath: [string]
}
```
## events
```js
// 'recieved'
// When a "deeplink" is recieved by the module, this event is emitted.
deeplink.on('received', (link) => {
// do something here
});
```
# Contributors
**This repo uses [semantic-release](https://semantic-release.gitbook.io/) for versioning, which uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).**
**semantic-release is hooked up to CircleCI**