platform/electron/overlay
Classes
Section titled “Classes”WindowOverlay
Section titled “WindowOverlay”Defined in: app/src/platform/electron/overlay.ts:32
A transparent view above the tabs of a window, for popovers and prompts that must cover web content, which lies above the shell. The view is made when it is first needed and is part of the window only while it shows something, because a view takes the clicks and the focus of what lies below it. A click next to the popover, Escape, a shortcut, a change of the window’s size or of its visible tab closes it, and the focus goes back to the page.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WindowOverlay(
window,options):WindowOverlay
Defined in: app/src/platform/electron/overlay.ts:44
Parameters
Section titled “Parameters”window
Section titled “window”The window that the overlay covers.
options
Section titled “options”What the overlays of all windows share.
Returns
Section titled “Returns”Accessors
Section titled “Accessors”content
Section titled “content”Get Signature
Section titled “Get Signature”get content():
OverlayContent|null
Defined in: app/src/platform/electron/overlay.ts:50
What the overlay shows, or null while it is closed.
Returns
Section titled “Returns”OverlayContent | null
contents
Section titled “contents”Get Signature
Section titled “Get Signature”get contents():
WebContents|undefined
Defined in: app/src/platform/electron/overlay.ts:55
The page of the overlay, once it exists.
Returns
Section titled “Returns”WebContents | undefined
Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: app/src/platform/electron/overlay.ts:92
Closes the overlay and gives the focus back to the page or the shell.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”open()
Section titled “open()”open(
content,onClose?):void
Defined in: app/src/platform/electron/overlay.ts:65
Shows content above the window’s tabs, or replaces what it shows.
Parameters
Section titled “Parameters”content
Section titled “content”What to show.
onClose?
Section titled “onClose?”() => void
Called once when the content closes or is replaced, such as to cancel what it asked for.
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
content):void
Defined in: app/src/platform/electron/overlay.ts:85
Changes what an open overlay shows, without taking the focus.
Parameters
Section titled “Parameters”content
Section titled “content”What to show.
Returns
Section titled “Returns”void
Interfaces
Section titled “Interfaces”OverlayOptions
Section titled “OverlayOptions”Defined in: app/src/platform/electron/overlay.ts:10
What the overlays of all windows share.
Properties
Section titled “Properties”appearanceArgument
Section titled “appearanceArgument”
readonlyappearanceArgument: () =>string
Defined in: app/src/platform/electron/overlay.ts:18
Command line argument that gives the page its design tokens.
Returns
Section titled “Returns”string
readonlygate:IpcGate
Defined in: app/src/platform/electron/overlay.ts:21
languageArguments
Section titled “languageArguments”
readonlylanguageArguments: readonlystring[]
Defined in: app/src/platform/electron/overlay.ts:20
Command line arguments that give the page its language.
partition
Section titled “partition”
readonlypartition:string
Defined in: app/src/platform/electron/overlay.ts:16
Partition of the browser’s own views.
preload
Section titled “preload”
readonlypreload:string
Defined in: app/src/platform/electron/overlay.ts:14
Path of the preload script of the browser’s own pages.
router
Section titled “router”
readonlyrouter:IpcRouter
Defined in: app/src/platform/electron/overlay.ts:22
readonlyurl:string
Defined in: app/src/platform/electron/overlay.ts:12
URL of the overlay page, normally app://overlay/.