webFrame Type
⚠ Process Availability: Main ❌ | Renderer ✔ | Utility ❌ | Exported ✔
Customize the rendering of the current web page.Process: Renderer> [!IMPORTANT] If you want to call this API from a renderer process with context isolation enabled, place the API call in your preload script and expose it using the contextBridge API.webFrame export of the Electron module is an instance of the WebFrame class representing the current frame. Sub-frames can be retrieved by certain properties and methods (e.g. webFrame.firstChild).An example of zooming current page to 200%.
Static members
| Static member |
Description
|
Full Usage:
webFrame.clearCache ()
Modifiers: inline |
Attempts to free memory that is no longer being used (like images from a previous navigation).Note that blindly calling this method probably makes Electron slower since it will have to refill these emptied caches, you should only call it if an event in your app has occurred that makes you think your page is actually using less memory (i.e. you have navigated from a super heavy page to a mostly empty one, and intend to stay there). |
|
A promise that resolves with the result of the executed code or is rejected if execution throws or results in a rejected promise.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.
|
A promise that resolves with the result of the executed code or is rejected if execution could not start.Works like executeJavaScript but evaluates scripts in an isolated context.Note that when the execution of script fails, the returned promise will not reject and the result would be undefined. This is because Chromium does not dispatch errors of isolated worlds to foreign worlds.
|
|
|
|
|
|
|
|
Full Usage:
webFrame.frameToken
Returns: string
|
A string representing the unique frame token in the current renderer process. Distinct WebFrame instances that refer to the same underlying frame will have the same frameToken.
|
|
|
|
|
Full Usage:
webFrame.getWordSuggestions word
Parameters:
string
Returns: string[]
Modifiers: inline |
A list of suggested words for a given word. If the word is spelled correctly, the result will be empty.
|
Full Usage:
webFrame.getZoomFactor ()
Returns: float
Modifiers: inline |
The current zoom factor.
|
Full Usage:
webFrame.getZoomLevel ()
Returns: float
Modifiers: inline |
The current zoom level.
|
Full Usage:
webFrame.insertCSS (css, ?cssOrigin)
Parameters:
string
?cssOrigin : CssOrigin
Returns: string
Modifiers: inline |
A key for the inserted CSS that can later be used to remove the CSS via webFrame.removeInsertedCSS(key).Injects CSS into the current web page and returns a unique key for the inserted stylesheet.
|
Full Usage:
webFrame.insertText text
Parameters:
string
Modifiers: inline |
Inserts text to the focused element.
|
Full Usage:
webFrame.isWordMisspelled word
Parameters:
string
Returns: bool
Modifiers: inline |
True if the word is misspelled according to the built in spellchecker, false otherwise. If no dictionary is loaded, always return false.
|
|
|
|
|
|
|
Full Usage:
webFrame.removeInsertedCSS key
Parameters:
string
Modifiers: inline |
Removes the inserted CSS from the current web page. The stylesheet is identified by its key, which is returned from webFrame.insertCSS(css).
|
Full Usage:
webFrame.setIsolatedWorldInfo (worldId, ?securityOrigin, ?csp, ?name)
Parameters:
int
?securityOrigin : string
?csp : string
?name : string
Modifiers: inline |
Set the security origin, content security policy and name of the isolated world.> [!NOTE] If the csp is specified, then the securityOrigin also has to be specified.
|
Full Usage:
webFrame.setSpellCheckProvider (language, provider)
Parameters:
string
provider : Provider
Modifiers: inline |
Sets a provider for spell checking in input fields and text areas.If you want to use this method you must disable the builtin spellchecker when you construct the window.The provider must be an object that has a spellCheck method that accepts an array of individual words for spellchecking. The spellCheck function runs asynchronously and calls the callback function with an array of misspelt words when complete.An example of using node-spellchecker as provider:
|
Full Usage:
webFrame.setVisualZoomLevelLimits (minimumLevel, maximumLevel)
Parameters:
float
maximumLevel : float
Modifiers: inline |
Sets the maximum and minimum pinch-to-zoom level.> [!NOTE] Visual zoom is disabled by default in Electron. To re-enable it, call:> [!NOTE] Visual zoom only applies to pinch-to-zoom behavior. Cmd+/-/0 zoom shortcuts are controlled by the 'zoomIn', 'zoomOut', and 'resetZoom' MenuItem roles in the application Menu. To disable shortcuts, manually define the Menu and omit zoom roles from the definition.
|
Full Usage:
webFrame.setZoomFactor factor
Parameters:
double
Modifiers: inline |
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.
|
Full Usage:
webFrame.setZoomLevel level
Parameters:
float
Modifiers: inline |
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.> [!NOTE] The zoom policy at the Chromium level is same-origin, meaning that the zoom level for a specific domain propagates across all instances of windows with the same domain. Differentiating the window URLs will make zoom work per-window.
|
|
fable-electron-docs-api