Skip to content
Implementation of Chrome extension APIs for Electron
TypeScript
Branch: master
Clone or download
Latest commit 76b4f2f Jul 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src refactor: extensions storage system Jul 24, 2019
.gitignore initial commit May 14, 2019
.prettierrc chore: add prettier config May 18, 2019
LICENSE chore: update license Jul 12, 2019
README.md docs: update docs Jul 4, 2019
package-lock.json refactor: extensions storage system Jul 24, 2019
package.json chore: bump version Jul 24, 2019
tsconfig.json feat: separate ipc calls to sessions Jul 3, 2019
tslint.json initial commit May 14, 2019

README.md

electron-extensions

electron-extensions will allow you to use Chrome extensions APIs with Electron.

Installation

$ npm install electron-extensions

Usage

The library is really easy-to-use. All you have to do is to put the following code in your main process:

import { ExtensibleSession } from 'electron-extensions';
import { app, session } from 'electron';

app.on('ready', () => {
  ...
  const extensions = new ExtensibleSession(session.defaultSession);
  extensions.loadExtension('C:/.../abcdefghijklmnoprstuwxyz'); // Path to the extension to load
  ...
});

Documentation

Class ExtensibleSession

new ExtensibleSession(session: Electron.Session)

  • session Electron.Session - used for injecting preloads to load content_scripts in all webContents within a given Electron session. Must be called in app ready event.

It's only for the main process. It's used to load extensions and handle their events.

Instance methods

loadExtension(path: string)

Loads an extension from a given path.

addWindow(window: Electron.BrowserWindow)

Adds a BrowserWindow to send and observe UI related events such as chrome.browserAction.setBadgeText or chrome.browserAction.onClicked.

Object extensionsRenderer

Usage in renderer

import { extensionsRenderer } from 'electron-extensions';

Instance methods

browserAction.onClicked(extensionId: string, tabId: number)

Sends chrome.browserAction.onClicked event to a given extension.

Events

set-badge-text

Emitted when chrome.browserAction.setBadgeText has been called in an extension.

Returns:

  • extensionId string
  • details chrome.browserAction.BadgeTextDetails

create-tab

Emitted when chrome.tabs.create has been called in an extension.

Example:
import { extensionsRenderer } from 'electron-extensions';

extensionsRenderer.on('create-tab', (details, callback) => {
  const tab = createTab(details) // Some create tab method...
  callback(tab.id);
})

Returns:

  • details chrome.tabs.CreateProperties
  • callback (tabId: number) => void - Must be called with the created tab id as an argument. Also, the tabId must be the same as any attached webContents id
You can’t perform that action at this time.