Skip to content

panel-renderer.md

Latest commit

 

History

History
46 lines (29 loc) · 1.25 KB

panel-renderer.md

File metadata and controls

46 lines (29 loc) · 1.25 KB

Panel (renderer process)

Methods

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 (renderer 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');
});

panel.contains (el)

  • el HTMLElement

Check if an element is a panel frame or in a panel frame.

panel.find (panelID)

  • panelID string

Find panel frame via panelID.

panel.closeAll ()

Close all panels. If any of the panel cancel close, none of the panel will be closed.