contents.getTitle() method
Returns string - the title of the current web page.
webcontents/methods
44 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.
contents.isDestroyed() method
Returns boolean - whether the web page is destroyed.
webContents.getAllWebContents() method
Returns WebContents[] - an array of all WebContents instances. This will contain web contents for all windows, webviews, opened DevTools, and DevTools extension background pages.
webContents.getFocusedWebContents() method
Returns WebContents | null - the web contents that is focused in the application, or null if no WebContents is focused.
webContents.fromId(id) method
Returns WebContents | undefined - a WebContents instance with the given ID, or undefined if there is no WebContents associated with the given ID. Parameters: id (Integer).
webContents.fromFrame(frame) method
Returns WebContents | undefined - a WebContents instance with the given WebFrameMain, or undefined if there is no WebContents associated with the given WebFrameMain. Parameters: frame (WebFrameMain).
webContents.fromDevToolsTargetId(targetId) method
Returns WebContents | undefined - a WebContents instance with the given Chrome DevTools Protocol TargetID, or undefined if there is no WebContents associated with the given TargetID. Parameters: targetId (string) - the Chrome DevTools Protocol TargetID associated with the WebContents instance. When communicating with the Chrome DevTools Protocol, this is useful for looking up a WebContents instance based on its assigned TargetID.
contents.undo() method
Executes the editing command undo in web page.
contents.redo() method
Executes the editing command redo in web page.
contents.loadURL(url[, options]) method
Loads the url in the window. The url must contain the protocol prefix, e.g. http:// or file://. Returns Promise<void> that resolves when the page has finished loading (see did-finish-load event) and rejects if the page fails to load (see did-fail-load event). A noop rejection handler is already attached to avoid unhandled rejection errors. If the existing page has a beforeUnload handler, did-fail-load will be called unless will-prevent-unload is handled. Parameters: url (string), options (Object, optional) with httpReferrer (string | Referrer, optional), userAgent (string, optional), extraHeaders (string, optional - extra headers separated by '\n'), postData (UploadRawData | UploadFile[], optional), baseURLForDataURL (string, optional) - base url for data url files.
contents.loadFile(filePath[, options]) method
Loads the given file in the window. filePath should be a path to an HTML file relative to the root of your application. Returns Promise<void> that resolves when the page has finished loading (see did-finish-load event) and rejects if the page fails to load (see did-fail-load event). Parameters: filePath (string), options (Object, optional) with query (Record<string, string>, optional), search (string, optional), hash (string, optional).
contents.downloadURL(url[, options]) method
Initiates a download of the resource at url without navigating. The will-download event of session will be triggered. Parameters: url (string), options (Object, optional) with headers (Record<string, string>, optional) - HTTP request headers.
contents.getURL() method
Returns string - the URL of the current web page.
contents.close([opts]) method
Closes the page, as if the web content had called window.close(). If the page is successfully closed (i.e. the unload is not prevented by the page, or waitForBeforeUnload is false or unspecified), the WebContents will be destroyed and no longer usable. The destroyed event will be emitted. Parameters: opts (Object, optional) with waitForBeforeUnload (boolean) - if true, fire the beforeunload event before closing the page; if the page prevents the unload, the WebContents will not be closed and will-prevent-unload will be fired.
contents.focus() method
Focuses the web page.
contents.isFocused() method
Returns boolean - whether the web page is focused.
contents.isLoading() method
Returns boolean - whether web page is still loading resources.
contents.isLoadingMainFrame() method
Returns boolean - whether the main frame (and not just iframes or frames within it) is still loading.
contents.isWaitingForResponse() method
Returns boolean - whether the web page is waiting for a first-response from the main resource of the page.
contents.stop() method
Stops any pending navigation.
contents.reload() method
Reloads the current web page.
contents.reloadIgnoringCache() method
Reloads current page and ignores cache.
Deprecated webContents navigation history methods
The following methods are deprecated and should use the new contents.navigationHistory API instead: canGoBack(), canGoForward(), canGoToOffset(offset), clearHistory(), goBack(), goForward(), goToIndex(index), goToOffset(offset). These methods were deprecated in PR #41752.
contents.isCrashed() method
Returns boolean - whether the renderer process has crashed.
contents.forcefullyCrashRenderer() method
Forcefully terminates the renderer process that is currently hosting this webContents. This will cause the render-process-gone event to be emitted with reason=killed or reason=crashed. Please note that some webContents share renderer processes and therefore calling this method may also crash the host process for other webContents as well. Calling reload() immediately after calling this method will force the reload to occur in a new process. This should be used when this process is unstable or unusable, for instance to recover from the unresponsive event.
contents.setUserAgent(userAgent) method
Overrides the user agent for this web page. Parameters: userAgent (string).
contents.getUserAgent() method
Returns string - the user agent for this web page.
contents.insertCSS(css[, options]) method
Injects CSS into the current web page and returns a unique key for the inserted stylesheet. Returns Promise<string> - a promise that resolves with a key for the inserted CSS that can later be used to remove the CSS via contents.removeInsertedCSS(key). Parameters: css (string), options (Object, optional) with cssOrigin (string, optional) - can be 'user' or 'author', sets the cascade origin of the inserted stylesheet, default is 'author'.
contents.removeInsertedCSS(key) method
Removes the inserted CSS from the current web page. The stylesheet is identified by its key, which is returned from contents.insertCSS(css). Returns Promise<void> - resolves if the removal was successful. Parameters: key (string).
contents.executeJavaScript(code[, userGesture]) method
Evaluates code in page. In the browser window some HTML APIs like requestFullScreen can only be invoked by a gesture from the user. Setting userGesture to true will remove this limitation. Code execution will be suspended until web page stop loading. Returns Promise<any> - a promise that resolves with the result of the executed code or is rejected if the result of the code is a rejected promise. Parameters: code (string), userGesture (boolean, optional, default false).
contents.cut() method
Executes the editing command cut in web page.
contents.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture]) method
Works like executeJavaScript but evaluates scripts in an isolated context. Returns Promise<any> - a promise that resolves with the result of the executed code or is rejected if the result of the code is a rejected promise. Parameters: worldId (Integer) - the ID of the world to run the javascript in (0 is the default world, 999 is the world used by Electron's contextIsolation feature; you can provide any integer), scripts (WebSource[]), userGesture (boolean, optional, default false).
contents.setIgnoreMenuShortcuts(ignore) method
Ignore application menu shortcuts while this web contents is focused. Parameters: ignore (boolean).
contents.setWindowOpenHandler(handler) method
Called before creating a window when a new window is requested by the renderer, e.g. by window.open(), a link with target='_blank', shift+clicking on a link, or submitting a form with <form target='_blank'>. Returns WindowOpenHandlerResponse - when set to { action: 'deny' } cancels the creation of the new window. { action: 'allow' } will allow the new window to be created. Returning an unrecognized value such as a null, undefined, or an object without a recognized 'action' value will result in a console error and have the same effect as returning {action: 'deny'}. Parameters: handler (Function) taking details (Object) with url (string) - the resolved version of the URL passed to window.open(), frameName (string), features (string) - comma separated list of window features, disposition (string) - can be 'default', 'foreground-tab', 'background-tab', 'new-window', or 'other', referrer (Referrer), postBody (PostBody, optional). Returns WindowOpenHandlerResponse with optional createWindow (Function) parameter.
contents.setAudioMuted(muted) method
Mute the audio on the current web page. Parameters: muted (boolean).
contents.isAudioMuted() method
Returns boolean - whether this page has been muted.
contents.isCurrentlyAudible() method
Returns boolean - whether audio is currently playing.
contents.setZoomFactor(factor) method
Changes the zoom factor to the specified factor. Zoom factor is zoom percent divided by 100, so 300% = 3.0. The factor must be greater than 0.0. Parameters: factor (Double, default 1.0).
contents.getZoomFactor() method
Returns number - the current zoom factor.
contents.setZoomLevel(level) method
Changes the zoom level to the specified level. The original size is 0 and each increment above or below represents zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. The formula for this is scale := 1.2 ^ level. The zoom policy at the Chromium level is same-origin by default, meaning that the zoom level for a specific domain propagates across all instances of windows with the same domain. To use per-webContents zoom instead, set the zoom mode to 'isolated' via contents.setZoomMode('isolated'). Parameters: level (number).
contents.getZoomLevel() method
Returns number - the current zoom level.
contents.setZoomMode(mode) method zoom modes
Sets the zoom mode for this web contents. Mode can be: 'default' - zoom changes are handled automatically on a per-origin basis; other webContents navigated to the same origin will share the same zoom level. 'isolated' - zoom changes are handled automatically but on a per-webContents basis; this webContents will not be affected by zoom changes in other webContents, and vice versa. 'manual' - automatic zoom handling is disabled; the zoom-changed event will still be dispatched, but the page will not actually be zoomed; the zoom level can be managed manually by the application. 'disabled' - all zooming in this webContents is disabled; the webContents will revert to the default zoom level and all zoom changes will be ignored. The 'isolated' and 'manual' zoom modes persist across navigations. Parameters: mode (string).
contents.getZoomMode() method
Returns string - the current zoom mode. Can be 'default', 'isolated', 'manual', or 'disabled'.
contents.setVisualZoomLevelLimits(minimumLevel, maximumLevel) method
Sets the maximum and minimum pinch-to-zoom level. Returns Promise<void>. Visual zoom is disabled by default in Electron. To re-enable it, call setVisualZoomLevelLimits(1, 3). Parameters: minimumLevel (number), maximumLevel (number).