platform/electron/browser-window

Classes

BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:191

One browser window: a BaseWindow with the shell view and one WebContentsView per tab. Tab views are created when a tab opens and destroyed when it closes; only the active tab’s view is attached to the window. Web pages and internal pages use views of different sessions: when a tab switches between them, its view is replaced and the old view’s history is kept for Back and Forward.

Implements

Constructors

Constructor

new BrowserWindowController(options, place?): BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:224

Parameters

options

BrowserWindowOptions

Environment of the window.

place?

WindowPlace = {}

Returns

BrowserWindowController

Properties

isPrivate

readonly isPrivate: boolean

Defined in: app/src/platform/electron/browser-window.ts:215

Whether the window is a private window.

overlay

overlay: OverlayHandle | undefined

Defined in: app/src/platform/electron/browser-window.ts:197

The overlay while it shows something; a change of the visible tab closes it.

readonly popup: boolean

Defined in: app/src/platform/electron/browser-window.ts:213

Whether the window is a popup that a page opened.

shell

readonly shell: WebContentsView

Defined in: app/src/platform/electron/browser-window.ts:193

tabs

readonly tabs: TabService

Defined in: app/src/platform/electron/browser-window.ts:194

window

readonly window: BaseWindow

Defined in: app/src/platform/electron/browser-window.ts:192

Accessors

activeTabContents

Get Signature

get activeTabContents(): WebContents | undefined

Defined in: app/src/platform/electron/browser-window.ts:306

The WebContents of the active tab, if any.

Returns

WebContents | undefined

closing

Get Signature

get closing(): boolean

Defined in: app/src/platform/electron/browser-window.ts:296

Whether the window closes: a window that closes right after it opened hides first.

Returns

boolean

shellContents

Get Signature

get shellContents(): WebContents

Defined in: app/src/platform/electron/browser-window.ts:301

The shell’s WebContents.

Returns

WebContents

Methods

adopt()

adopt(contents, url, activate): string

Defined in: app/src/platform/electron/browser-window.ts:407

Shows the page that a script of another page opened in a new tab, which keeps that page as its opener.

Parameters

WebContents

The new page, which Chromium made for the script.

url

string

The address it opens.

activate

boolean

Whether the tab becomes the active one.

Returns

string

The tab.

countBlocked()

countBlocked(contentsId): boolean

Defined in: app/src/platform/electron/browser-window.ts:349

Counts a request that the content blocker blocked, if it belongs to one of this window’s tabs.

Parameters

contentsId

number

Id of the web contents that made the request.

Returns

boolean

Whether the request belonged to this window.

create()

create(id, url, lazy?): void

Defined in: app/src/platform/electron/browser-window.ts:382

Creates the view of a tab and loads the URL. A lazy tab gets its view only when it is shown, so restored tabs cost nothing until they are used.

Parameters

id

string

url

string

lazy?

boolean = false

Returns

void

Implementation of

TabViewPort.create

destroy()

destroy(id): void

Defined in: app/src/platform/electron/browser-window.ts:489

Destroys the view of a tab.

Parameters

id

string

Returns

void

Implementation of

TabViewPort.destroy

dispose()

dispose(): void

Defined in: app/src/platform/electron/browser-window.ts:561

Closes the window and every tab view.

Returns

void

Implementation of

Disposable.dispose

execute()

execute(command): void

Defined in: app/src/platform/electron/browser-window.ts:577

Runs a window command, such as opening a tab.

Parameters

command

WindowCommand

The command.

Returns

void

find()

find(id, query, forward, next): void

Defined in: app/src/platform/electron/browser-window.ts:693

Looks for text in a tab’s page, or for its next or previous match.

Parameters

id

string

The tab.

query

string

The text.

forward

boolean

Whether to look forward.

boolean

Whether to go on from the current match.

Returns

void

focusContent()

focusContent(): void

Defined in: app/src/platform/electron/browser-window.ts:478

Focuses the visible tab, or the shell for the new tab page, where typing goes to the address bar.

Returns

void

load()

load(id, url): void

Defined in: app/src/platform/electron/browser-window.ts:505

Loads a URL in a tab.

Parameters

id

string

url

string

Returns

void

Implementation of

TabViewPort.load

openPage()

openPage(page): void

Defined in: app/src/platform/electron/browser-window.ts:762

Shows an internal page: the tab that already shows it, or else the active tab if it shows the new tab page, or else a new tab.

Parameters

page

"newtab" | "settings" | "setup" | "history" | "bookmarks"

The page.

Returns

void

ownsTab()

ownsTab(contents): boolean

Defined in: app/src/platform/electron/browser-window.ts:370

Tells whether a WebContents is one of this window’s tab views.

Parameters

WebContents

Returns

boolean

proceedUnsafely()

proceedUnsafely(id, accept): void

Defined in: app/src/platform/electron/browser-window.ts:447

Continues to a page whose certificate was refused, once the certificate is accepted.

Parameters

id

string

The tab.

accept

(contents) => boolean

Accepts the certificate that the page’s web contents were refused.

Returns

void

refreshShell()

refreshShell(): void

Defined in: app/src/platform/electron/browser-window.ts:339

Sends the shell its state again, for example after the layout settings changed.

Returns

void

repaintBackground()

repaintBackground(): void

Defined in: app/src/platform/electron/browser-window.ts:548

Paints the window and the views of internal pages in the current light or dark mode.

Returns

void

run()

run(id, action): void

Defined in: app/src/platform/electron/browser-window.ts:521

Runs a history or loading action.

Parameters

id

string

action

"back" | "forward" | "reload" | "stop"

Returns

void

Implementation of

TabViewPort.run

setInsets()

setInsets(insets): void

Defined in: app/src/platform/electron/browser-window.ts:364

Updates the space the shell occupies.

Parameters

insets

Insets

New insets in CSS pixels.

Returns

void

show()

show(id): void

Defined in: app/src/platform/electron/browser-window.ts:416

Shows the view of a tab and hides the previously shown one.

Parameters

id

string

Returns

void

Implementation of

TabViewPort.show

state()

state(): object

Defined in: app/src/platform/electron/browser-window.ts:312

The current shell state, as sent to the shell.

Returns

object

activeTabId

activeTabId: string | null

bookmarksBar

bookmarksBar: object[] | null

downloads

downloads: { active: number; progress: number | null; } | null

find

find: { active: number; matches: number; query: string; } | null

private

private: boolean

tabs

tabs: object[]

tabStrip

tabStrip: "left" | "top" | "bottom" | "right"

stopFind()

stopFind(id): void

Defined in: app/src/platform/electron/browser-window.ts:711

Closes the find bar and leaves the current match selected.

Parameters

id

string

The tab.

Returns

void

tabIdOf()

tabIdOf(contents): string | undefined

Defined in: app/src/platform/electron/browser-window.ts:378

Finds the tab that a WebContents shows.

Parameters

WebContents

A tab view’s WebContents.

Returns

string | undefined

zoom()

zoom(id, direction): void

Defined in: app/src/platform/electron/browser-window.ts:726

Zooms a tab’s page in or out by one step, or back to 100 %. The zoom holds for the page’s site, in every tab, and is remembered for the next visit.

Parameters

id

string

The tab.

direction

-1 | 0 | 1

1 to zoom in, -1 to zoom out, 0 for 100 %.

Returns

void

WindowManager

Defined in: app/src/platform/electron/browser-window.ts:1136

Keeps track of open windows and routes shell requests to the right one.

Implements

Disposable

Constructors

Constructor

new WindowManager(options): WindowManager

Defined in: app/src/platform/electron/browser-window.ts:1150

Parameters

options

BrowserWindowOptions

Environment for new windows.

Returns

WindowManager

Properties

onDidChange

readonly onDidChange: Event<void>

Defined in: app/src/platform/electron/browser-window.ts:1143

Fires after windows opened or closed, or their tabs changed.

onDidMove

readonly onDidMove: Event<void>

Defined in: app/src/platform/electron/browser-window.ts:1146

Fires while a window moves or changes its size.

Accessors

all

Get Signature

get all(): readonly BrowserWindowController[]

Defined in: app/src/platform/electron/browser-window.ts:1321

All open windows.

Returns

readonly BrowserWindowController[]

lastUsed

Get Signature

get lastUsed(): BrowserWindowController | undefined

Defined in: app/src/platform/electron/browser-window.ts:1288

The open window that had the focus last, or else the newest open window.

Returns

BrowserWindowController | undefined

Methods

countBlocked()

countBlocked(contentsId): void

Defined in: app/src/platform/electron/browser-window.ts:1329

Counts a request that the content blocker blocked in the tab that made it.

Parameters

contentsId

number

Id of the web contents that made the request.

Returns

void

dispose()

dispose(): void

Defined in: app/src/platform/electron/browser-window.ts:1350

Closes every window.

Returns

void

Implementation of

Disposable.dispose

forShell()

forShell(sender): BrowserWindowController | undefined

Defined in: app/src/platform/electron/browser-window.ts:1308

Finds the window whose shell sent a request.

Parameters

sender

WebContents

The sending WebContents.

Returns

BrowserWindowController | undefined

forTab()

forTab(contents): BrowserWindowController | undefined

Defined in: app/src/platform/electron/browser-window.ts:1316

Finds the window that shows a tab view.

Parameters

WebContents

A tab’s WebContents.

Returns

BrowserWindowController | undefined

lastUsedOf()

lastUsedOf(privateWindow): BrowserWindowController | undefined

Defined in: app/src/platform/electron/browser-window.ts:1298

The regular or the private window that had the focus last, or else the newest one; popups are left out, as their pages expect to be alone in them.

Parameters

privateWindow

boolean

Whether to find a private window.

Returns

BrowserWindowController | undefined

open()

open(url?, place?): BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:1159

Opens a window with one tab.

Parameters

url?

string

What the tab shows; a new tab page without it.

place?

WindowPlace

Where the window opens, and whether it is private.

Returns

BrowserWindowController

openPopup()

openPopup(contents, url, features, opener, privateWindow): BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:1189

Opens a popup that a script of a page opened, where and as large as the page asked, with the new page, which keeps its opener.

Parameters

WebContents

The new page.

url

string

The address it opens.

features

string

The features that the script asked for, such as its size.

opener

BrowserWindowController | undefined

The window of the page that opened it.

privateWindow

boolean

Whether the page that opened it is in a private window.

Returns

BrowserWindowController

The popup.

openWith()

openWith(contents, url, place?): BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:1173

Opens a window whose only tab shows a page that a script of another page opened, which keeps its opener.

Parameters

WebContents

The new page.

url

string

The address it opens.

place?

WindowPlace = {}

Where the window opens.

Returns

BrowserWindowController

The window.

refreshShells()

refreshShells(): void

Defined in: app/src/platform/electron/browser-window.ts:1336

Sends every shell its state again.

Returns

void

repaintBackgrounds()

repaintBackgrounds(): void

Defined in: app/src/platform/electron/browser-window.ts:1343

Paints every window in the current light or dark mode.

Returns

void

restore()

restore(session): BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:1214

Opens the windows of a stored session. Only the active tab of each window loads; the others load when they are shown.

Parameters

session

The windows and their tabs.

version

1 = ...

windows

object[] = ...

Returns

BrowserWindowController

The first window.

snapshot()

snapshot(): object

Defined in: app/src/platform/electron/browser-window.ts:1236

The tabs of every open window, as a session keeps them.

Returns

object

version

version: 1

windows

windows: object[]

toDisposable()

toDisposable(): Disposable

Defined in: app/src/platform/electron/browser-window.ts:1358

Returns a disposable that closes all windows.

Returns

Disposable

Interfaces

BrowserWindowOptions

Defined in: app/src/platform/electron/browser-window.ts:65

Everything a window needs from its environment.

Properties

appearanceArgument

readonly appearanceArgument: () => string

Defined in: app/src/platform/electron/browser-window.ts:85

Command line argument that gives a view of the browser’s own UI its design tokens.

Returns

string

backgroundColor

readonly backgroundColor: (privateWindow) => string

Defined in: app/src/platform/electron/browser-window.ts:83

Window background while the shell loads: for the light or dark mode, or a private window.

Parameters

privateWindow

boolean

Returns

string

blocking

readonly blocking: (url) => Blocking

Defined in: app/src/platform/electron/browser-window.ts:91

Whether the content blocker works on a page: none for pages it never touches.

Parameters

url

string

Returns

Blocking

bookmarksBar?

readonly optional bookmarksBar?: () => object[] | null

Defined in: app/src/platform/electron/browser-window.ts:99

The items of the bookmarks bar, or null while the bar is hidden.

Returns

object[] | null

certificateOverride?

readonly optional certificateOverride?: () => boolean

Defined in: app/src/platform/electron/browser-window.ts:120

Whether people may continue to a site whose certificate is not trusted.

Returns

boolean

downloads?

readonly optional downloads?: (privateWindow) => { active: number; progress: number | null; } | null

Defined in: app/src/platform/electron/browser-window.ts:103

How the downloads button of a regular or a private window looks, or null while it is hidden.

Parameters

privateWindow

boolean

Returns

{ active: number; progress: number | null; } | null

gate

readonly gate: IpcGate

Defined in: app/src/platform/electron/browser-window.ts:114

internalPartition

readonly internalPartition: string

Defined in: app/src/platform/electron/browser-window.ts:75

Partition of the browser’s own views.

isBookmarked?

readonly optional isBookmarked?: (url) => boolean

Defined in: app/src/platform/electron/browser-window.ts:95

Whether a page has a bookmark, for the star in the address bar.

Parameters

url

string

Returns

boolean

languageArguments

readonly languageArguments: readonly string[]

Defined in: app/src/platform/electron/browser-window.ts:87

Command line arguments that give the views of the browser’s own UI their language.

logger

readonly logger: Logger

Defined in: app/src/platform/electron/browser-window.ts:116

newTabUrl

readonly newTabUrl: string

Defined in: app/src/platform/electron/browser-window.ts:81

URL of a new tab.

onContextMenu?

readonly optional onContextMenu?: (request) => void

Defined in: app/src/platform/electron/browser-window.ts:118

Shows the context menu of a view; without it, views have none.

Parameters

request

ContextMenuRequest

Returns

void

onFocus?

readonly optional onFocus?: () => void

Defined in: app/src/platform/electron/browser-window.ts:113

Called when a window gets the focus.

Returns

void

onPageCommand?

readonly optional onPageCommand?: (window, command, contents) => void

Defined in: app/src/platform/electron/browser-window.ts:122

Prints, saves or shows the source of a web page, or opens its developer tools.

Parameters

window

BrowserWindowController

command

PageCommand

WebContents

Returns

void

onPrivateWindowsClosed?

readonly optional onPrivateWindowsClosed?: () => void

Defined in: app/src/platform/electron/browser-window.ts:111

Called after the last private window closed, to forget what private windows kept.

Returns

void

onUnresponsive?

readonly optional onUnresponsive?: (window, tabId, contents) => void

Defined in: app/src/platform/electron/browser-window.ts:132

Asks what to do about a web page that stopped responding to input.

Parameters

window

BrowserWindowController

tabId

string

WebContents

Returns

void

onVisit?

readonly optional onVisit?: (url, title, titleOnly) => void

Defined in: app/src/platform/electron/browser-window.ts:93

Called when a tab shows a web page, and again when its title changes.

Parameters

url

string

title

string

titleOnly

boolean

Returns

void

onZoom?

readonly optional onZoom?: (url, factor) => void

Defined in: app/src/platform/electron/browser-window.ts:130

Remembers the zoom factor of a site.

Parameters

url

string

factor

number

Returns

void

openPrivateWindow?

readonly optional openPrivateWindow?: () => void

Defined in: app/src/platform/electron/browser-window.ts:109

Opens a new private window, if people may.

Returns

void

openWindow?

readonly optional openWindow?: () => void

Defined in: app/src/platform/electron/browser-window.ts:107

Opens a new window.

Returns

void

pagePreload

readonly pagePreload: string

Defined in: app/src/platform/electron/browser-window.ts:73

Path of the preload script of internal pages in tabs.

prepareInternalPage?

readonly optional prepareInternalPage?: (page) => Promise<void> | undefined

Defined in: app/src/platform/electron/browser-window.ts:141

Gets the browser process ready for an internal page before the page loads, such as by loading the handlers of its channels; undefined when it is ready already.

Parameters

page

"newtab" | "settings" | "setup" | "history" | "bookmarks"

Returns

Promise<void> | undefined

privateSession

readonly privateSession: () => Session

Defined in: app/src/platform/electron/browser-window.ts:79

The session of web tabs in private windows, which keeps their data in memory.

Returns

Session

router

readonly router: IpcRouter

Defined in: app/src/platform/electron/browser-window.ts:115

shellOrigin

readonly shellOrigin: string

Defined in: app/src/platform/electron/browser-window.ts:69

Origin the shell page must have.

shellPreload

readonly shellPreload: string

Defined in: app/src/platform/electron/browser-window.ts:71

Path of the shell’s preload script.

shellUrl

readonly shellUrl: string

Defined in: app/src/platform/electron/browser-window.ts:67

URL of the shell page, normally app://shell/.

showDownloads?

readonly optional showDownloads?: (window) => void

Defined in: app/src/platform/electron/browser-window.ts:105

Shows the list of downloads of a window, at its button.

Parameters

window

BrowserWindowController

Returns

void

tabStripPosition

readonly tabStripPosition: () => "left" | "top" | "bottom" | "right"

Defined in: app/src/platform/electron/browser-window.ts:89

Where the shell shows the tab strip.

Returns

"left" | "top" | "bottom" | "right"

toggleBookmark?

readonly optional toggleBookmark?: (url, title) => void

Defined in: app/src/platform/electron/browser-window.ts:97

Adds a bookmark for a page, or removes its bookmarks.

Parameters

url

string

title

string

Returns

void

toggleBookmarksBar?

readonly optional toggleBookmarksBar?: () => void

Defined in: app/src/platform/electron/browser-window.ts:101

Shows or hides the bookmarks bar.

Returns

void

webPartition

readonly webPartition: string

Defined in: app/src/platform/electron/browser-window.ts:77

Partition of web tabs.

zoomFor?

readonly optional zoomFor?: (url) => number | undefined

Defined in: app/src/platform/electron/browser-window.ts:128

The zoom factor that a site was left at, to give its pages again.

Parameters

url

string

Returns

number | undefined

ContextMenuRequest

Defined in: app/src/platform/electron/browser-window.ts:51

A view’s request for its context menu, with what the menu needs to know about the view.

Properties

bounds

readonly bounds: Rectangle

Defined in: app/src/platform/electron/browser-window.ts:61

Where the view is in the window, for menus opened with the keyboard.

readonly contents: WebContents

Defined in: app/src/platform/electron/browser-window.ts:57

The view’s web contents.

params

readonly params: ContextMenuParams

Defined in: app/src/platform/electron/browser-window.ts:59

What was clicked, as Chromium reports it.

tabId

readonly tabId: string | undefined

Defined in: app/src/platform/electron/browser-window.ts:55

The tab whose page was clicked; undefined for the shell.

window

readonly window: BrowserWindowController

Defined in: app/src/platform/electron/browser-window.ts:53

The window that shows the view.

Insets

Defined in: app/src/platform/electron/browser-window.ts:43

Space the shell occupies at the window edges.

Properties

bottom

readonly bottom: number

Defined in: app/src/platform/electron/browser-window.ts:46

left

readonly left: number

Defined in: app/src/platform/electron/browser-window.ts:47

right

readonly right: number

Defined in: app/src/platform/electron/browser-window.ts:45

top

readonly top: number

Defined in: app/src/platform/electron/browser-window.ts:44

OverlayHandle

Defined in: app/src/platform/electron/browser-window.ts:153

What a window needs of its overlay.

Methods

close()

close(): void

Defined in: app/src/platform/electron/browser-window.ts:155

Closes the overlay and gives the focus back to the page or the shell.

Returns

void

WindowPlace

Defined in: app/src/platform/electron/browser-window.ts:159

Where a window opens, and whether it is a popup that a page opened.

Properties

bounds?

readonly optional bounds?: WindowBounds

Defined in: app/src/platform/electron/browser-window.ts:160

maximized?

readonly optional maximized?: boolean

Defined in: app/src/platform/electron/browser-window.ts:161

readonly optional popup?: boolean

Defined in: app/src/platform/electron/browser-window.ts:163

A popup closes with its last tab and is not kept in the session.

private?

readonly optional private?: boolean

Defined in: app/src/platform/electron/browser-window.ts:165

A private window keeps no history and no session, and its pages’ data only in memory.

Type Aliases

PageCommand

PageCommand = "page.print" | "page.save" | "page.source" | "devtools.toggle"

Defined in: app/src/platform/electron/browser-window.ts:145

The commands that tools outside the window carry out on a web page.