Header menu logo fable-electron-docs-api

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

webFrame.clearCache ()

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).

webFrame.executeJavaScript (code, ?userGesture, ?callback)

Full Usage: webFrame.executeJavaScript (code, ?userGesture, ?callback)

Parameters:
    code : string
    ?userGesture : bool
    ?callback : obj * Error -> unit

Returns: Promise<obj>
Modifiers: inline

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.

code : string
?userGesture : bool
?callback : obj * Error -> unit
Returns: Promise<obj>

webFrame.executeJavaScriptInIsolatedWorld (worldId, scripts, ?userGesture, ?callback)

Full Usage: webFrame.executeJavaScriptInIsolatedWorld (worldId, scripts, ?userGesture, ?callback)

Parameters:
    worldId : int
    scripts : WebSource[]
    ?userGesture : bool
    ?callback : obj * Error -> unit

Returns: Promise<obj>
Modifiers: inline

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.

worldId : int
scripts : WebSource[]
?userGesture : bool
?callback : obj * Error -> unit
Returns: Promise<obj>

webFrame.findFrameByName name

Full Usage: webFrame.findFrameByName name

Parameters:
    name : string

Returns: Option<webFrame>
Modifiers: inline

A child of webFrame with the supplied name, null would be returned if there's no such frame or if the frame is not in the current renderer process.

name : string
Returns: Option<webFrame>

webFrame.findFrameByToken frameToken

Full Usage: webFrame.findFrameByToken frameToken

Parameters:
    frameToken : string

Returns: Option<webFrame>
Modifiers: inline

that has the supplied frameToken, null if not found.

frameToken : string
Returns: Option<webFrame>

webFrame.firstChild

Full Usage: webFrame.firstChild

Returns: Option<webFrame>

A WebFrame | null representing the first child frame of webFrame, the property would be null if webFrame has no children or if first child is not in the current renderer process.

Returns: Option<webFrame>

webFrame.frameToken

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.

Returns: string

webFrame.getFrameForSelector selector

Full Usage: webFrame.getFrameForSelector selector

Parameters:
    selector : string

Returns: Option<webFrame>
Modifiers: inline

The frame element in webFrame's document selected by selector, null would be returned if selector does not select a frame or if the frame is not in the current renderer process.

selector : string
Returns: Option<webFrame>

webFrame.getResourceUsage ()

Full Usage: webFrame.getResourceUsage ()

Returns: GetResourceUsage
Modifiers: inline

  • images MemoryUsageDetails* scripts MemoryUsageDetails* cssStyleSheets MemoryUsageDetails* xslStyleSheets MemoryUsageDetails* fonts MemoryUsageDetails* other MemoryUsageDetailsReturns an object describing usage information of Blink's internal memory caches.This will generate:

Returns: GetResourceUsage

webFrame.getWordSuggestions word

Full Usage: webFrame.getWordSuggestions word

Parameters:
    word : 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.

word : string
Returns: string[]

webFrame.getZoomFactor ()

Full Usage: webFrame.getZoomFactor ()

Returns: float
Modifiers: inline

The current zoom factor.

Returns: float

webFrame.getZoomLevel ()

Full Usage: webFrame.getZoomLevel ()

Returns: float
Modifiers: inline

The current zoom level.

Returns: float

webFrame.insertCSS (css, ?cssOrigin)

Full Usage: webFrame.insertCSS (css, ?cssOrigin)

Parameters:
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.

css : string
?cssOrigin : CssOrigin
Returns: string

webFrame.insertText text

Full Usage: webFrame.insertText text

Parameters:
    text : string

Modifiers: inline

Inserts text to the focused element.

text : string

webFrame.isWordMisspelled word

Full Usage: webFrame.isWordMisspelled word

Parameters:
    word : 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.

word : string
Returns: bool

webFrame.nextSibling

Full Usage: webFrame.nextSibling

Returns: Option<webFrame>

A WebFrame | null representing next sibling frame, the property would be null if webFrame is the last frame in its parent or if the next sibling is not in the current renderer process.

Returns: Option<webFrame>

webFrame.opener

Full Usage: webFrame.opener

Returns: Option<webFrame>

A WebFrame | null representing the frame which opened webFrame, the property would be null if there's no opener or opener is not in the current renderer process.

Returns: Option<webFrame>

webFrame.parent

Full Usage: webFrame.parent

Returns: Option<webFrame>

A WebFrame | null representing parent frame of webFrame, the property would be null if webFrame is top or parent is not in the current renderer process.

Returns: Option<webFrame>

webFrame.removeInsertedCSS key

Full Usage: webFrame.removeInsertedCSS key

Parameters:
    key : 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).

key : string

webFrame.setIsolatedWorldInfo (worldId, ?securityOrigin, ?csp, ?name)

Full Usage: webFrame.setIsolatedWorldInfo (worldId, ?securityOrigin, ?csp, ?name)

Parameters:
    worldId : 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.

worldId : int
?securityOrigin : string
?csp : string
?name : string

webFrame.setSpellCheckProvider (language, provider)

Full Usage: webFrame.setSpellCheckProvider (language, provider)

Parameters:
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:

language : string
provider : Provider

webFrame.setVisualZoomLevelLimits (minimumLevel, maximumLevel)

Full Usage: webFrame.setVisualZoomLevelLimits (minimumLevel, maximumLevel)

Parameters:
    minimumLevel : 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.

minimumLevel : float
maximumLevel : float

webFrame.setZoomFactor factor

Full Usage: webFrame.setZoomFactor factor

Parameters:
    factor : 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.

factor : double

webFrame.setZoomLevel level

Full Usage: webFrame.setZoomLevel level

Parameters:
    level : 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.

level : float

webFrame.top

Full Usage: webFrame.top

Returns: Option<webFrame>

A WebFrame | null representing top frame in frame hierarchy to which webFrame belongs, the property would be null if top frame is not in the current renderer process.

Returns: Option<webFrame>

Type something to start searching.