Skip to content

panel-main.md

Latest commit

 

History

History
44 lines (28 loc) · 1.19 KB

panel-main.md

File metadata and controls

44 lines (28 loc) · 1.19 KB

Panel (main process)

Methods

panel.findWindow (panelID)

  • panelID string - The panelID.

Find and return an editor window that contains the panelID.

panel.getPanels (win)

  • BrowserWindow win

Returns Array - panelID(s)

Get all panels in window.

panel.send (panelID, message[, ...args, callback, timeout])

  • panelID string - Panel ID.
  • message string - Ipc message.
  • ...args ... - Whatever arguments the message needs.
  • callback function - You can specify a callback function to receive IPC reply at the last or the 2nd last argument.
  • timeout number - You can specify a timeout for the callback at the last argument. If no timeout specified, it will be 5000ms.

Send message with ...args to panel defined in renderer process asynchronously. It is possible to add a callback as the last or the 2nd last argument to receive replies from the IPC receiver.

Example:

Send IPC message (main process)

const panel = require('electron-panel');

panel.send('foobar', 'foobar:say-hello', err => {
  if ( err.code === 'ETIMEOUT' ) {
    console.error('Timeout for ipc message foobar:say-hello');
    return;
  }

  console.log('foobar replied');
});