webFrameMain
Control web pages and iframes.
Processus : Main
The webFrameMain
module can be used to lookup frames across existing WebContents
instances. Navigation events are the common use case.
const { BrowserWindow, webFrameMain } = require('electron')
const win = new BrowserWindow({ width: 800, height: 1500 })
win.loadURL('https://twitter.com')
win.webContents.on(
'did-frame-navigate',
(event, url, isMainFrame, frameProcessId, frameRoutingId) => {
const frame = webFrameMain.fromId(frameProcessId, frameRoutingId)
if (frame) {
const code = 'document.body.innerHTML = document.body.innerHTML.replaceAll("heck", "h*ck")'
frame.executeJavaScript(code)
}
}
)
You can also access frames of existing pages by using the mainFrame
property of WebContents
.
const { BrowserWindow } = require('electron')
async function main () {
const win = new BrowserWindow({ width: 800, height: 600 })
await win.loadURL('https://reddit.com')
const youtubeEmbeds = win.webContents.mainFrame.frames.filter((frame) => {
try {
const url = new URL(frame.url)
return url.host === 'www.youtube.com'
} catch {
return false
}
})
console.log(youtubeEmbeds)
}
main()
Méthodes
These methods can be accessed from the webFrameMain
module:
webFrameMain.fromId(processId, routingId)
processId
Integer - AnInteger
representing the internal ID of the process which owns the frame.routingId
Integer - AnInteger
representing the unique frame ID in the current renderer process. Routing IDs can be retrieved fromWebFrameMain
instances (frame.routingId
) and are also passed by frame specificWebContents
navigation events (e.g.did-frame-navigate
).
Returns WebFrameMain | undefined
- A frame with the given process and routing IDs, or undefined
if there is no WebFrameMain associated with the given IDs.
Class: WebFrameMain
Processus : Principal
Cette classe n'est pas exportée depuis le module 'electron'
. Il n'est disponible qu'en tant que valeur de retour des autres méthodes dans l'API Electron.
Événements d’instance
Événement : 'dom-ready'
Emitted when the document is loaded.
Méthodes d’instance
frame.executeJavaScript(code[, userGesture])
code
stringuserGesture
boolean (optional) - Default isfalse
.
Returns Promise<unknown>
- A promise that resolves with the result of the executed code or is rejected if execution throws or results in a rejected promise.
Évalue le code
dans la page.
Dans la fenêtre du navigateur, certaines APIs HTML comme requestFullScreen
peut être invoqué seulement par un geste de l'utilisateur. Définir userGesture
à true
supprimera cette limitation.
frame.reload()
Returns boolean
- Whether the reload was initiated successfully. Only results in false
when the frame has no history.
frame.send(channel, ...args)
channel
string...args
any[]
Send an asynchronous message to the renderer process via channel
, along with arguments. Arguments will be serialized with the [Structured Clone Algorithm][SCA], just like [postMessage
][], so prototype chains will not be included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw an exception.
The renderer process can handle the message by listening to channel
with the ipcRenderer
module.
frame.postMessage(channel, message, [transfer])
channel
stringmessage
toustransfer
MessagePortMain[] (optional)
Envoie un message au processus de rendu en effectuant éventuellement un transfert de propriété de zéro ou plus objets de type [MessagePortMain
][].
Les objets MessagePortMain
transférés seront disponibles dans le processus de rendu en accédant à la propriété ports
de l'événement émis. Ils seront des objets DOM MessagePort
natifs en arrivant dans le moteur de rendu.
Par exemple :
// Main process
const { port1, port2 } = new MessageChannelMain()
webContents.mainFrame.postMessage('port', { message: 'hello' }, [port1])
// Renderer process
ipcRenderer.on('port', (e, msg) => {
const [port] = e.ports
// ...
})
Propriétés d'instance
frame.url
Readonly
A string
representing the current URL of the frame.
frame.top
Readonly
A WebFrameMain | null
representing top frame in the frame hierarchy to which frame
belongs.
frame.parent
Readonly
A WebFrameMain | null
representing parent frame of frame
, the property would be null
if frame
is the top frame in the frame hierarchy.
frame.frames
Readonly
A WebFrameMain[]
collection containing the direct descendents of frame
.
frame.framesInSubtree
Readonly
A WebFrameMain[]
collection containing every frame in the subtree of frame
, including itself. This can be useful when traversing through all frames.
frame.frameTreeNodeId
Readonly
An Integer
representing the id of the frame's internal FrameTreeNode instance. This id is browser-global and uniquely identifies a frame that hosts content. The identifier is fixed at the creation of the frame and stays constant for the lifetime of the frame. When the frame is removed, the id is not used again.
frame.name
Readonly
A string
representing the frame name.
frame.osProcessId
Readonly
An Integer
representing the operating system pid
of the process which owns this frame.
frame.processId
Readonly
An Integer
representing the Chromium internal pid
of the process which owns this frame. This is not the same as the OS process ID; to read that use frame.osProcessId
.
frame.routingId
Readonly
An Integer
representing the unique frame id in the current renderer process. Distinct WebFrameMain
instances that refer to the same underlying frame will have the same routingId
.
frame.visibilityState
Lecture seule
A string
representing the visibility state of the frame.
See also how the Page Visibility API is affected by other Electron APIs.