Giter Club home page Giter Club logo

electron-chrome-extension's Introduction

Electron Chrome Extension

Build Status

Environment

Tested with Electron v4.0.4 - Node v8.9.0 - NPM v5.5.1

Setup

  • Renderer - preload
require('electron-chrome-extension/preload');

For some reasons the navigator user agent is not inherited from the session so you will need to redefine the user agent via the Object.defineProperty method after the import

  • Main
import ECx from 'electron-chrome-extension';

app.on('ready', async () => {
  createWindow();

  // Load Grammarly
  await ECx.load('kbfnbcaeplbcioakkpcpgfkobkghlhen');
});

Connect your application logic

Extensions react to browser events for trigger their own logic. ECx send inner webContents events to extensions subscribers but external events like creating new window, changing tab focus etc should be triggered on your side like this:

// main.js

ipcMain.on('YOUR_EVENT', (...) =>
  ECx.sendEvent({
    channel: 'tabs.onActivated',
    payload: [{ tabId, windowId }],
  })
);

Usage with DevTools extension

โš ๏ธ electron-chrome-extension will break Electron's support for Devtools extensions.

If you wish to use devtools extensions, make sure to add the prelaod on the Session itself:

if (isDev) {
  app.on('session-created', session => {
    session.setPreloads([path.join(__dirname, 'node_modules/electron-chrome-extension/preload')]
  });
}

It is not recommended to have the preload added to Sessions outside developement environnement because it can lead to have extension's code run in priviledged contexts (BrowserWindows with nodeIntegration for instance).

Then install Chrome DevTools extensions with electron-chrome-extension:

import ECx from 'electron-chrome-extension';
// load React Dev Tools
ECx.load('jdkknkkbebbapilgoeccciglkfbmbnfm');

ECx APIs

  • ECx.load(extensionId: IExtension['id']): Promise<IExtension>
  • ECx.unload(extensionId: IExtension['id']): void
  • ECx.setConfiguration(configuration: Configuration = {}): Promise<ECx>
  • ECx.isLoaded(extensionId: IExtension['id']): boolean
  • ECx.isUpToDate(extensionId: IExtension['id']): Promise<boolean>
  • ECx.get(extensionId: IExtension['id']): Promise<IExtension>
  • ECx.sendEvent(event: ExtensionEventMessage): void

Tools

  • Start Playground
$ npm start

You can tweak the playground files at your convenience and extensions would automatically downloaded and clean app data with $ npm run playground:reset

  • Test
$ npm test

We use electron-mocha for run our test suit. Warning (because not explained in the lib): test assertions lives in the renderer, the main remains accessible for IPC calls and Electron Main API calls.

  • Publish
$ npm publish

References

Know supported extensions

as of 05/29/19 with their Chrome WebStore ID

  • Mixmax: ocpljaamllnldhepankaeljmeeeghnid
  • Gmelius: dheionainndbbpoacpnopgmnihkcmnkl
  • Mailtracker: pgbdljpkijehgoacbjpolaomhkoffhnl
  • Boomerang: mdanidgdpmkimeiiojknlnekblgmpdll
  • Clearbit Connect: pmnhcgfcafcnkbengdcanjablaabjplo
  • Grammarly: kbfnbcaeplbcioakkpcpgfkobkghlhen
  • React Developers Tools: fmkadmapgofadopljbjfkapdkoienihi
  • Redux DevTools: lmhkpmbekcpmknklioeibfkpmmfibljd
  • Apollo Client Developer Tools: jdkknkkbebbapilgoeccciglkfbmbnfm

electron-chrome-extension's People

Contributors

alexstrat avatar dependabot[bot] avatar hugomano avatar magne4000 avatar nacryn avatar v-zhzhou avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.