sendEnterURL

Tell browser view to load url

sendEnterURL

Parameters

url (string)

sendChangeURL

Tell browser view url in address bar changed

sendChangeURL

Parameters

url (string)

sendGoBack

Tell browser view to goBack

sendGoBack

sendGoForward

Tell browser view to goForward

sendGoForward

sendCloseTab

Tell browser view to close tab

sendCloseTab

Parameters

id (TabID)

sendNewTab

Create a new tab

sendNewTab

Parameters

url (string?)

references (object?)

sendSwitchTab

Tell browser view to switch to specified tab

sendSwitchTab

Parameters

id (TabID)

TabID

BrowserView's id as tab id

TabID

Type: number

Tab

Tab

Type: object

Properties

url (string) : tab's url(address bar)

href (string) : tab's loaded page url(location.href)

title (string) : tab's title

favicon (string) : tab's favicon url

isLoading (boolean)

canGoBack (boolean)

canGoForward (boolean)

Tabs

Tabs

Type: Object<TabID, Tab>

Bounds

Bounds

Type: object

Properties

x (number)

y (number)

width (number)

height (number)

BrowserLikeWindow

A browser like window

new BrowserLikeWindow(options: object)

Extends EventEmitter

Parameters

options (object)

Name	Description
options.width number (default 1024)	browser window's width
options.height number (default 800)	browser window's height
options.controlPanel string	control interface path to load
options.controlHeight number (default 130)	control interface's height
options.viewReferences object?	webReferences for every BrowserView
options.controlReferences object?	webReferences for control panel BrowserView
options.winOptions object?	options for BrowserWindow
options.startPage string (default '')	start page to load on browser open
options.blankPage string (default '')	blank page to load on new tab
options.blankTitle string (default 'about:blank')	blank page's title
options.onNewWindow function?	custom webContents new-window event handler
options.debug boolean?	toggle debug

Instance Members

▸ getControlBounds()

Get control view's bounds

getControlBounds(): Bounds

Returns

Bounds: Bounds of control view(exclude window's frame)

▸ newTab(url, appendTo?, references)

Create a tab

newTab(url: string, appendTo: number?, references: object)

Parameters

url (string = this.options.blankPage)

appendTo (number?) add next to specified tab's id

references (object = this.options.viewReferences) custom webPreferences to this tab

▸ switchTab(viewId)

Swith to tab

switchTab(viewId: TabID)

Parameters

viewId (TabID)

BrowserLikeWindow#closed

closed event

BrowserLikeWindow#closed

BrowserLikeWindow#control-ready

control-ready event.

BrowserLikeWindow#control-ready

Type: IpcMainEvent

BrowserLikeWindow#url-updated

url-updated event.

BrowserLikeWindow#url-updated

Returns

BrowserView: view - current browser view

Returns

string: href - updated url

BrowserLikeWindow#new-tab

new-tab event.

BrowserLikeWindow#new-tab

Returns

BrowserView: view - current browser view

Returns

string: [source.openedURL] - opened with url

Returns

BrowserView: source.lastView - previous active view

useConnect

A custom hook to create ipc connection between BrowserView and ControlView

useConnect(options: object)

Parameters

options (object = {})

Name	Description
options.onTabsUpdate function	trigger after tabs updated(title, favicon, loading etc.)
options.onTabActive function	trigger after active tab changed