609f3349.1d34cf7d.js

js electronjs.org collected 2026-09-24 07:04:17 UTC 496,473 bytes, 1 lines download raw bytes

1"use strict";(self.webpackChunkelectronjs=self.webpackChunkelectronjs||[]).push([["25460"],{80716(e,t,n){n.r(t),n.d(t,{metadata:()=>o,default:()=>u,frontMatter:()=>r,contentTitle:()=>a,toc:()=>f,assets:()=>d});var o=JSON.parse('{"id":"latest/api/web-contents","title":"webContents","description":"Render and control web pages.","source":"@site/docs/latest/api/web-contents.md","sourceDirName":"latest/api","slug":"/latest/api/web-contents","permalink":"/docs/latest/api/web-contents","draft":false,"unlisted":false,"editUrl":"https://github.com/electron/electron/edit/main/docs/api/web-contents.md","tags":[],"version":"current","frontMatter":{"title":"webContents","description":"Render and control web pages.","slug":"web-contents","hide_title":false},"sidebar":"api","previous":{"title":"utilityProcess","permalink":"/docs/latest/api/utility-process"},"next":{"title":"WebContentsView","permalink":"/docs/latest/api/web-contents-view"}}'),i=n(74848),s=n(28453),l=n(56346),c=n(40329);let r={title:"webContents",description:"Render and control web pages.",slug:"web-contents",hide_title:!1},a="webContents",d={},f=[{value:"Navigation Events",id:"navigation-events",level:2},{value:"Document Navigations",id:"document-navigations",level:3},{value:"In-page Navigation",id:"in-page-navigation",level:3},{value:"Frame Navigation",id:"frame-navigation",level:3},{value:"Methods",id:"methods",level:2},{value:"<code>webContents.getAllWebContents()</code>",id:"webcontentsgetallwebcontents",level:3},{value:"<code>webContents.getFocusedWebContents()</code>",id:"webcontentsgetfocusedwebcontents",level:3},{value:"<code>webContents.fromId(id)</code>",id:"webcontentsfromidid",level:3},{value:"<code>webContents.fromFrame(frame)</code>",id:"webcontentsfromframeframe",level:3},{value:"<code>webContents.fromDevToolsTargetId(targetId)</code>",id:"webcontentsfromdevtoolstargetidtargetid",level:3},{value:"Class: WebContents",id:"class-webcontents",level:2},{value:"Instance Events",id:"instance-events",level:3},{value:"Event: &#39;did-finish-load&#39;",id:"event-did-finish-load",level:4},{value:"Event: &#39;did-fail-load&#39;",id:"event-did-fail-load",level:4},{value:"Event: &#39;did-fail-provisional-load&#39;",id:"event-did-fail-provisional-load",level:4},{value:"Event: &#39;did-frame-finish-load&#39;",id:"event-did-frame-finish-load",level:4},{value:"Event: &#39;did-start-loading&#39;",id:"event-did-start-loading",level:4},{value:"Event: &#39;did-stop-loading&#39;",id:"event-did-stop-loading",level:4},{value:"Event: &#39;dom-ready&#39;",id:"event-dom-ready",level:4},{value:"Event: &#39;page-title-updated&#39;",id:"event-page-title-updated",level:4},{value:"Event: &#39;page-favicon-updated&#39;",id:"event-page-favicon-updated",level:4},{value:"Event: &#39;content-bounds-updated&#39;",id:"event-content-bounds-updated",level:4},{value:"Event: &#39;did-create-window&#39;",id:"event-did-create-window",level:4},{value:"Event: &#39;will-navigate&#39;",id:"event-will-navigate",level:4},{value:"Event: &#39;will-frame-navigate&#39;",id:"event-will-frame-navigate",level:4},{value:"Event: &#39;did-start-navigation&#39;",id:"event-did-start-navigation",level:4},{value:"Event: &#39;will-redirect&#39;",id:"event-will-redirect",level:4},{value:"Event: &#39;did-redirect-navigation&#39;",id:"event-did-redirect-navigation",level:4},{value:"Event: &#39;did-navigate&#39;",id:"event-did-navigate",level:4},{value:"Event: &#39;did-frame-navigate&#39;",id:"event-did-frame-navigate",level:4},{value:"Event: &#39;did-navigate-in-page&#39;",id:"event-did-navigate-in-page",level:4},{value:"Event: &#39;will-prevent-unload&#39;",id:"event-will-prevent-unload",level:4},{value:"Event: &#39;render-process-gone&#39;",id:"event-render-process-gone",level:4},{value:"Event: &#39;unresponsive&#39;",id:"event-unresponsive",level:4},{value:"Event: &#39;responsive&#39;",id:"event-responsive",level:4},{value:"Event: &#39;destroyed&#39;",id:"event-destroyed",level:4},{value:"Event: &#39;input-event&#39;",id:"event-input-event",level:4},{value:"Event: &#39;before-input-event&#39;",id:"event-before-input-event",level:4},{value:"Event: &#39;before-mouse-event&#39;",id:"event-before-mouse-event",level:4},{value:"Event: &#39;enter-html-full-screen&#39;",id:"event-enter-html-full-screen",level:4},{value:"Event: &#39;leave-html-full-screen&#39;",id:"event-leave-html-full-screen",level:4},{value:"Event: &#39;zoom-changed&#39;",id:"event-zoom-changed",level:4},{value:"Event: &#39;blur&#39;",id:"event-blur",level:4},{value:"Event: &#39;focus&#39;",id:"event-focus",level:4},{value:"Event: &#39;devtools-open-url&#39;",id:"event-devtools-open-url",level:4},{value:"Event: &#39;devtools-search-query&#39;",id:"event-devtools-search-query",level:4},{value:"Event: &#39;devtools-opened&#39;",id:"event-devtools-opened",level:4},{value:"Event: &#39;devtools-closed&#39;",id:"event-devtools-closed",level:4},{value:"Event: &#39;devtools-focused&#39;",id:"event-devtools-focused",level:4},{value:"Event: &#39;certificate-error&#39;",id:"event-certificate-error",level:4},{value:"Event: &#39;select-client-certificate&#39;",id:"event-select-client-certificate",level:4},{value:"Event: &#39;login&#39;",id:"event-login",level:4},{value:"Event: &#39;found-in-page&#39;",id:"event-found-in-page",level:4},{value:"Event: &#39;media-started-playing&#39;",id:"event-media-started-playing",level:4},{value:"Event: &#39;media-paused&#39;",id:"event-media-paused",level:4},{value:"Event: &#39;audio-state-changed&#39;",id:"event-audio-state-changed",level:4},{value:"Event: &#39;did-change-theme-color&#39;

1",id:"event-did-change-theme-color",level:4},{value:"Event: &#39;update-target-url&#39;",id:"event-update-target-url",level:4},{value:"Event: &#39;cursor-changed&#39;",id:"event-cursor-changed",level:4},{value:"Event: &#39;context-menu&#39;",id:"event-context-menu",level:4},{value:"Event: &#39;select-bluetooth-device&#39;",id:"event-select-bluetooth-device",level:4},{value:"Event: &#39;paint&#39;",id:"event-paint",level:4},{value:"Event: &#39;devtools-reload-page&#39;",id:"event-devtools-reload-page",level:4},{value:"Event: &#39;will-attach-webview&#39;",id:"event-will-attach-webview",level:4},{value:"Event: &#39;did-attach-webview&#39;",id:"event-did-attach-webview",level:4},{value:"Event: &#39;console-message&#39;",id:"event-console-message",level:4},{value:"Event: &#39;preload-error&#39;",id:"event-preload-error",level:4},{value:"Event: &#39;ipc-message&#39;",id:"event-ipc-message",level:4},{value:"Event: &#39;ipc-message-sync&#39;",id:"event-ipc-message-sync",level:4},{value:"Event: &#39;preferred-size-changed&#39;",id:"event-preferred-size-changed",level:4},{value:"Event: &#39;frame-created&#39;",id:"event-frame-created",level:4},{value:"Instance Methods",id:"instance-methods",level:3},{value:"<code>contents.loadURL(url[, options])</code>",id:"contentsloadurlurl-options",level:4},{value:"<code>contents.loadFile(filePath[, options])</code>",id:"contentsloadfilefilepath-options",level:4},{value:"<code>contents.downloadURL(url[, options])</code>",id:"contentsdownloadurlurl-options",level:4},{value:"<code>contents.getURL()</code>",id:"contentsgeturl",level:4},{value:"<code>contents.getTitle()</code>",id:"contentsgettitle",level:4},{value:"<code>contents.isDestroyed()</code>",id:"contentsisdestroyed",level:4},{value:"<code>contents.close([opts])</code>",id:"contentscloseopts",level:4},{value:"<code>contents.focus()</code>",id:"contentsfocus",level:4},{value:"<code>contents.isFocused()</code>",id:"contentsisfocused",level:4},{value:"<code>contents.isLoading()</code>",id:"contentsisloading",level:4},{value:"<code>contents.isLoadingMainFrame()</code>",id:"contentsisloadingmainframe",level:4},{value:"<code>contents.isWaitingForResponse()</code>",id:"contentsiswaitingforresponse",level:4},{value:"<code>contents.stop()</code>",id:"contentsstop",level:4},{value:"<code>contents.reload()</code>",id:"contentsreload",level:4},{value:"<code>contents.reloadIgnoringCache()</code>",id:"contentsreloadignoringcache",level:4},{value:"<code>contents.canGoBack()</code> <em>Deprecated</em>",id:"contentscangoback-deprecated",level:4},{value:"<code>contents.canGoForward()</code> <em>Deprecated</em>",id:"contentscangoforward-deprecated",level:4},{value:"<code>contents.canGoToOffset(offset)</code> <em>Deprecated</em>",id:"contentscangotooffsetoffset-deprecated",level:4},{value:"<code>contents.clearHistory()</code> <em>Deprecated</em>",id:"contentsclearhistory-deprecated",level:4},{value:"<code>contents.goBack()</code> <em>Deprecated</em>",id:"contentsgoback-deprecated",level:4},{value:"<code>contents.goForward()</code> <em>Deprecated</em>",id:"contentsgoforward-deprecated",level:4},{value:"<code>contents.goToIndex(index)</code> <em>Deprecated</em>",id:"contentsgotoindexindex-deprecated",level:4},{value:"<code>contents.goToOffset(offset)</code> <em>Deprecated</em>",id:"contentsgotooffsetoffset-deprecated",level:4},{value:"<code>contents.isCrashed()</code>",id:"contentsiscrashed",level:4},{value:"<code>contents.forcefullyCrashRenderer()</code>",id:"contentsforcefullycrashrenderer",level:4},{value:"<code>contents.setUserAgent(userAgent)</code>",id:"contentssetuseragentuseragent",level:4},{value:"<code>contents.getUserAgent()</code>",id:"contentsgetuseragent",level:4},{value:"<code>contents.insertCSS(css[, options])</code>",id:"contentsinsertcsscss-options",level:4},{value:"<code>contents.removeInsertedCSS(key)</code>",id:"contentsremoveinsertedcsskey",level:4},{value:"<code>contents.executeJavaScript(code[, userGesture])</code>",id:"contentsexecutejavascriptcode-usergesture",level:4},{value:"<code>contents.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture])</code>

1",id:"contentsexecutejavascriptinisolatedworldworldid-scripts-usergesture",level:4},{value:"<code>contents.setIgnoreMenuShortcuts(ignore)</code>",id:"contentssetignoremenushortcutsignore",level:4},{value:"<code>contents.setWindowOpenHandler(handler)</code>",id:"contentssetwindowopenhandlerhandler",level:4},{value:"<code>contents.setAudioMuted(muted)</code>",id:"contentssetaudiomutedmuted",level:4},{value:"<code>contents.isAudioMuted()</code>",id:"contentsisaudiomuted",level:4},{value:"<code>contents.isCurrentlyAudible()</code>",id:"contentsiscurrentlyaudible",level:4},{value:"<code>contents.setCaretBrowsingEnabled(enabled)</code>",id:"contentssetcaretbrowsingenabledenabled",level:4},{value:"<code>contents.isCaretBrowsingEnabled()</code>",id:"contentsiscaretbrowsingenabled",level:4},{value:"<code>contents.setZoomFactor(factor)</code>",id:"contentssetzoomfactorfactor",level:4},{value:"<code>contents.getZoomFactor()</code>",id:"contentsgetzoomfactor",level:4},{value:"<code>contents.setZoomLevel(level)</code>",id:"contentssetzoomlevellevel",level:4},{value:"<code>contents.getZoomLevel()</code>",id:"contentsgetzoomlevel",level:4},{value:"<code>contents.setZoomMode(mode)</code>",id:"contentssetzoommodemode",level:4},{value:"<code>contents.getZoomMode()</code>",id:"contentsgetzoommode",level:4},{value:"<code>contents.setVisualZoomLevelLimits(minimumLevel, maximumLevel)</code>",id:"contentssetvisualzoomlevellimitsminimumlevel-maximumlevel",level:4},{value:"<code>contents.undo()</code>",id:"contentsundo",level:4},{value:"<code>contents.redo()</code>",id:"contentsredo",level:4},{value:"<code>contents.cut()</code>",id:"contentscut",level:4},{value:"<code>contents.copy()</code>",id:"contentscopy",level:4},{value:"<code>contents.centerSelection()</code>",id:"contentscenterselection",level:4},{value:"<code>contents.copyImageAt(x, y)</code>",id:"contentscopyimageatx-y",level:4},{value:"<code>contents.copyVideoFrameAt(x, y)</code>",id:"contentscopyvideoframeatx-y",level:4},{value:"<code>contents.saveVideoFrameAs(x, y)</code>",id:"contentssavevideoframeasx-y",level:4},{value:"<code>contents.paste()</code>",id:"contentspaste",level:4},{value:"<code>contents.pasteAndMatchStyle()</code>",id:"contentspasteandmatchstyle",level:4},{value:"<code>contents.delete()</code>",id:"contentsdelete",level:4},{value:"<code>contents.selectAll()</code>",id:"contentsselectall",level:4},{value:"<code>contents.unselect()</code>",id:"contentsunselect",level:4},{value:"<code>contents.scrollToTop()</code>",id:"contentsscrolltotop",level:4},{value:"<code>contents.scrollToBottom()</code>",id:"contentsscrolltobottom",level:4},{value:"<code>contents.adjustSelection(options)</code>",id:"contentsadjustselectionoptions",level:4},{value:"<code>contents.replace(text)</code>",id:"contentsreplacetext",level:4},{value:"<code>contents.replaceMisspelling(text)</code>",id:"contentsreplacemisspellingtext",level:4},{value:"<code>contents.insertText(text)</code>",id:"contentsinserttexttext",level:4},{value:"<code>contents.findInPage(text[, options])</code>",id:"contentsfindinpagetext-options",level:4},{value:"<code>contents.stopFindInPage(action)</code>",id:"contentsstopfindinpageaction",level:4},{value:"<code>contents.capturePage([rect, opts])</code>",id:"contentscapturepagerect-opts",level:4},{value:"<code>contents.isBeingCaptured()</code>",id:"contentsisbeingcaptured",level:4},{value:"<code>contents.getPrintersAsync()</code>",id:"contentsgetprintersasync",level:4},{value:"<code>contents.print([options], [callback])</code>",id:"contentsprintoptions-callback",level:4},{value:"<code>contents.printToPDF(options)</code>",id:"contentsprinttopdfoptions",level:4},{value:"<code>contents.addWorkSpace(path)</code>",id:"contentsaddworkspacepath",level:4},{value:"<code>contents.removeWorkSpace(path)</code>",id:"contentsremoveworkspacepath",level:4},{value:"<code>contents.setDevToolsWebContents(devToolsWebContents)</code>",id:"contentssetdevtoolswebcontentsdevtoolswebcontents",level:4},{value:"<code>contents.openDevTools([options])</code>",id:"contentsopendevtoolsoptions",level:4},{value:"<code>contents.closeDevTools()</code>

1",id:"contentsclosedevtools",level:4},{value:"<code>contents.isDevToolsOpened()</code>",id:"contentsisdevtoolsopened",level:4},{value:"<code>contents.isDevToolsFocused()</code>",id:"contentsisdevtoolsfocused",level:4},{value:"<code>contents.getDevToolsTitle()</code>",id:"contentsgetdevtoolstitle",level:4},{value:"<code>contents.setDevToolsTitle(title)</code>",id:"contentssetdevtoolstitletitle",level:4},{value:"<code>contents.toggleDevTools()</code>",id:"contentstoggledevtools",level:4},{value:"<code>contents.inspectElement(x, y)</code>",id:"contentsinspectelementx-y",level:4},{value:"<code>contents.inspectSharedWorker()</code>",id:"contentsinspectsharedworker",level:4},{value:"<code>contents.inspectSharedWorkerById(workerId)</code>",id:"contentsinspectsharedworkerbyidworkerid",level:4},{value:"<code>contents.getAllSharedWorkers()</code>",id:"contentsgetallsharedworkers",level:4},{value:"<code>contents.inspectServiceWorker()</code>",id:"contentsinspectserviceworker",level:4},{value:"<code>contents.send(channel, ...args)</code>",id:"contentssendchannel-args",level:4},{value:"<code>contents.sendToFrame(frameId, channel, ...args)</code>",id:"contentssendtoframeframeid-channel-args",level:4},{value:"<code>contents.postMessage(channel, message, [transfer])</code>",id:"contentspostmessagechannel-message-transfer",level:4},{value:"<code>contents.enableDeviceEmulation(parameters)</code>",id:"contentsenabledeviceemulationparameters",level:4},{value:"<code>contents.disableDeviceEmulation()</code>",id:"contentsdisabledeviceemulation",level:4},{value:"<code>contents.sendInputEvent(inputEvent)</code>",id:"contentssendinputeventinputevent",level:4},{value:"<code>contents.beginFrameSubscription([onlyDirty ,]callback)</code>",id:"contentsbeginframesubscriptiononlydirty-callback",level:4},{value:"<code>contents.endFrameSubscription()</code>",id:"contentsendframesubscription",level:4},{value:"<code>contents.startDrag(item)</code>",id:"contentsstartdragitem",level:4},{value:"<code>contents.savePage(fullPath, saveType)</code>",id:"contentssavepagefullpath-savetype",level:4},{value:"<code>contents.showDefinitionForSelection()</code> <em>macOS</em>",id:"contentsshowdefinitionforselection-macos",level:4},{value:"<code>contents.isOffscreen()</code>",id:"contentsisoffscreen",level:4},{value:"<code>contents.startPainting()</code>",id:"contentsstartpainting",level:4},{value:"<code>contents.stopPainting()</code>",id:"contentsstoppainting",level:4},{value:"<code>contents.isPainting()</code>",id:"contentsispainting",level:4},{value:"<code>contents.setFrameRate(fps)</code>",id:"contentssetframeratefps",level:4},{value:"<code>contents.getFrameRate()</code>",id:"contentsgetframerate",level:4},{value:"<code>contents.invalidate()</code>",id:"contentsinvalidate",level:4},{value:"<code>contents.getWebRTCIPHandlingPolicy()</code>",id:"contentsgetwebrtciphandlingpolicy",level:4},{value:"<code>contents.setWebRTCIPHandlingPolicy(policy)</code>",id:"contentssetwebrtciphandlingpolicypolicy",level:4},{value:"<code>contents.getWebRTCUDPPortRange()</code>",id:"contentsgetwebrtcudpportrange",level:4},{value:"<code>contents.setWebRTCUDPPortRange(udpPortRange)</code>",id:"contentssetwebrtcudpportrangeudpportrange",level:4},{value:"<code>contents.getMediaSourceId(requestWebContents)</code>",id:"contentsgetmediasourceidrequestwebcontents",level:4},{value:"<code>contents.getOrCreateDevToolsTargetId()</code>",id:"contentsgetorcreatedevtoolstargetid",level:4},{value:"<code>contents.getOSProcessId()</code>",id:"contentsgetosprocessid",level:4},{value:"<code>contents.getProcessId()</code>",id:"contentsgetprocessid",level:4},{value:"<code>contents.clone()</code>",id:"contentsclone",level:4},{value:"<code>

1contents.takeHeapSnapshot(filePath)</code>",id:"contentstakeheapsnapshotfilepath",level:4},{value:"<code>contents.getBackgroundThrottling()</code>",id:"contentsgetbackgroundthrottling",level:4},{value:"<code>contents.setBackgroundThrottling(allowed)</code>",id:"contentssetbackgroundthrottlingallowed",level:4},{value:"<code>contents.getType()</code>",id:"contentsgettype",level:4},{value:"<code>contents.setImageAnimationPolicy(policy)</code>",id:"contentssetimageanimationpolicypolicy",level:4},{value:"Instance Properties",id:"instance-properties",level:3},{value:"<code>contents.ipc</code> <em>Readonly</em>",id:"contentsipc-readonly",level:4},{value:"<code>contents.audioMuted</code>",id:"contentsaudiomuted",level:4},{value:"<code>contents.caretBrowsingEnabled</code>",id:"contentscaretbrowsingenabled",level:4},{value:"<code>contents.userAgent</code>",id:"contentsuseragent",level:4},{value:"<code>contents.zoomLevel</code>",id:"contentszoomlevel",level:4},{value:"<code>contents.zoomFactor</code>",id:"contentszoomfactor",level:4},{value:"<code>contents.zoomMode</code>",id:"contentszoommode",level:4},{value:"<code>contents.frameRate</code>",id:"contentsframerate",level:4},{value:"<code>contents.id</code> <em>Readonly</em>",id:"contentsid-readonly",level:4},{value:"<code>contents.session</code> <em>Readonly</em>",id:"contentssession-readonly",level:4},{value:"<code>contents.navigationHistory</code> <em>Readonly</em>",id:"contentsnavigationhistory-readonly",level:4},{value:"<code>contents.hostWebContents</code> <em>Readonly</em>",id:"contentshostwebcontents-readonly",level:4},{value:"<code>contents.devToolsWebContents</code> <em>Readonly</em>",id:"contentsdevtoolswebcontents-readonly",level:4},{value:"<code>contents.debugger</code> <em>Readonly</em>",id:"contentsdebugger-readonly",level:4},{value:"<code>contents.backgroundThrottling</code>",id:"contentsbackgroundthrottling",level:4},{value:"<code>contents.mainFrame</code> <em>Readonly</em>",id:"contentsmainframe-readonly",level:4},{value:"<code>contents.opener</code> <em>Readonly</em>",id:"contentsopener-readonly",level:4},{value:"<code>contents.focusedFrame</code> <em>Readonly</em>",id:"contentsfocusedframe-readonly",level:4}];function p(e){let t={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"webcontents",children:"webContents"})}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsx)(t.p,{children:"Render and control web pages."}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Process: ",(0,i.jsx)(t.a,{href:"/docs/latest/glossary#main-process",children:"Main"})]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"webContents"})," is an ",(0,i.jsx)(t.a,{href:"https://nodejs.org/api/events.html#events_class_eventemitter",children:"EventEmitter"}),".\nIt is responsible for rendering and controlling a web page and is a property of\nthe ",(0,i.jsx)(t.a,{href:"/docs/latest/api/browser-window",children:(0,i.jsx)(t.code,{children:"BrowserWindow"})})," object. An example of accessing the\n",(0,i.jsx)(t.code,{children:"webContents"})," object:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ width: 800, height: 1500 })\nwin.loadURL('https://github.com')\n\nconst contents = win.webContents\nconsole.log(contents)\n"})}),"\n",(0,i.jsx)(t.h2,{id:"navigation-events",children:"Navigation Events"}),"\n",(0,i.jsxs)(t.p,{children:["Several events can be used to monitor navigations as they occur within a ",(0,i.jsx)(t.code,{children:"webContents"}),"."]}),"\n",(0,i.jsx)(t.h3,{id:"document-navigations",children:"Document Navigations"}),"\n",(0,i.jsxs)(t.p,{children:["When a ",(0,i.jsx)(t.code,{children:"webContents"})," navigates to another page (as opposed to an ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#in-page-navigation",children:"in-page navigation"}),"), the following events will be fired."]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-start-navigation",children:(0,i.jsx)(t.code,{children:"did-start-navigation"})})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-will-frame-navigate",children:(0,i.jsx)(t.code,{children:"will-frame-navigate"})})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-will-navigate",children:(0,i.jsx)(t.code,{children:"will-navigate"})})," (only fired when main frame navigates)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-will-redirect",children:(0,i.jsx)(t.code,{children:"will-redirect"})})," (only fired when a redirect happens during navigation)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-redirect-navigation",children:(0,i.jsx)(t.code,{children:"did-redirect-navigation"})})," (only fired when a redirect happens during navigation)"]}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-frame-navigate",children:(0,i.jsx)(t.code,{children:"did-frame-navigate"})})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-navigate",children:(0,i.jsx)(t.code,{children:"did-navigate"})})," (only fired when main frame navigates)"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Subsequent events will not fire if ",(0,i.jsx)(t.code,{children:"event.preventDefault()"})," is called on any of the cancellable events."]}),"\n",(0,i.jsx)(t.h3,{id:"in-page-navigation",children:"In-page Navigation"}),"\n",(0,i.jsx)(t.p,{children:"In-page navigations don't cause the page to reload, but instead navigate to a location within the current page. These events are not cancellable. For an in-page navigations, the following events will fire in this order:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-start-navigation",children:(0,i.jsx)(t.code,{children:"did-start-navigation"})})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-navigate-in-page",children:(0,i.jsx)(t.code,{children:"did-navigate-in-page"})})}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"frame-navigation",children:"Frame Navigation"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-will-navigate",children:(0,i.jsx)(t.code,{children:"will-navigate"})})," and ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-navigate",children:(0,i.jsx)(t.code,{children:"did-navigate"})})," events only fire when the ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#contentsmainframe-readonly",children:"mainFrame"})," navigates.\nIf you want to also observe navigations in ",(0,i.jsx)(t.code,{children:"<iframe>"}),"s, use ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-will-frame-navigate",children:(0,i.jsx)(t.code,{children:"will-frame-navigate"})})," and ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-frame-navigate",children:(0,i.jsx)(t.code,{children:"did-frame-navigate"})})," events."]}),"\n",(0,i.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsxs)(t.p,{children:["These methods can be accessed from the ",(0,i.jsx)(t.code,{children:"webContents"})," module:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { webContents } = require('electron')\n\nconsole.log(webContents)\n"})}),"\n",(0,i.jsx)(t.h3,{id:"webcontentsgetallwebcontents",children:(0,i.jsx)(t.code,{children:"webContents.getAllWebContents()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WebContents[]"})," - An array of all ",(0,i.jsx)(t.code,{children:"WebContents"})," instances. This will contain web contents\nfor all windows, webviews, opened DevTools, and DevTools extension background pages."]}

1),"\n",(0,i.jsx)(t.h3,{id:"webcontentsgetfocusedwebcontents",children:(0,i.jsx)(t.code,{children:"webContents.getFocusedWebContents()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WebContents | null"})," - The web contents that is focused in this application, otherwise\nreturns ",(0,i.jsx)(t.code,{children:"null"}),"."]}),"\n",(0,i.jsx)(t.h3,{id:"webcontentsfromidid",children:(0,i.jsx)(t.code,{children:"webContents.fromId(id)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"id"})," Integer"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WebContents | undefined"})," - A WebContents instance with the given ID, or\n",(0,i.jsx)(t.code,{children:"undefined"})," if there is no WebContents associated with the given ID."]}),"\n",(0,i.jsx)(t.h3,{id:"webcontentsfromframeframe",children:(0,i.jsx)(t.code,{children:"webContents.fromFrame(frame)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WebContents | undefined"})," - A WebContents instance with the given WebFrameMain, or\n",(0,i.jsx)(t.code,{children:"undefined"})," if there is no WebContents associated with the given WebFrameMain."]}),"\n",(0,i.jsx)(t.h3,{id:"webcontentsfromdevtoolstargetidtargetid",children:(0,i.jsx)(t.code,{children:"webContents.fromDevToolsTargetId(targetId)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"targetId"})," string - The Chrome DevTools Protocol ",(0,i.jsx)(t.a,{href:"https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID",children:"TargetID"})," associated with the WebContents instance."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WebContents | undefined"})," - A WebContents instance with the given TargetID, or\n",(0,i.jsx)(t.code,{children:"undefined"})," if there is no WebContents associated with the given TargetID."]}),"\n",(0,i.jsxs)(t.p,{children:["When communicating with the ",(0,i.jsx)(t.a,{href:"https://chromedevtools.github.io/devtools-protocol/",children:"Chrome DevTools Protocol"}),",\nit can be useful to lookup a WebContents instance based on its assigned TargetID."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"async function lookupTargetId(browserWindow) {\n  const wc = browserWindow.webContents\n  await wc.debugger.attach('1.3')\n  const { targetInfo } = await wc.debugger.sendCommand('Target.getTargetInfo')\n  const { targetId } = targetInfo\n  const targetWebContents = await wc.fromDevToolsTargetId(targetId)\n}\n"})}),"\n",(0,i.jsx)(t.h2,{id:"class-webcontents",children:"Class: WebContents"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsx)(t.p,{children:"Render and control the contents of a BrowserWindow instance."}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Process: ",(0,i.jsx)(t.a,{href:"/docs/latest/glossary#main-process",children:"Main"}),(0,i.jsx)("br",{}),"\n",(0,i.jsxs)(t.em,{children:["This class is not exported from the ",(0,i.jsx)(t.code,{children:"'electron'"})," module. It is only available as a return value of other methods in the Electron API."]})]}),"\n",(0,i.jsx)(t.h3,{id:"instance-events",children:"Instance Events"}),"\n",(0,i.jsx)(t.h4,{id:"event-did-finish-load",children:"Event: 'did-finish-load'"}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the navigation is done, i.e. the spinner of the tab has stopped\nspinning, and the ",(0,i.jsx)(t.code,{children:"onload"})," event was dispatched."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-fail-load",children:"Event: 'did-fail-load'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"errorCode"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"errorDescription"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"val

1idatedURL"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["This event is like ",(0,i.jsx)(t.code,{children:"did-finish-load"})," but emitted when the load failed.\nThe full list of error codes and their meaning is available ",(0,i.jsx)(t.a,{href:"https://source.chromium.org/chromium/chromium/src/+/main:net/base/net_error_list.h",children:"here"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-fail-provisional-load",children:"Event: 'did-fail-provisional-load'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"errorCode"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"errorDescription"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"validatedURL"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["This event is like ",(0,i.jsx)(t.code,{children:"did-fail-load"})," but emitted when the load was cancelled\n(e.g. ",(0,i.jsx)(t.code,{children:"window.stop()"})," was invoked)."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-frame-finish-load",children:"Event: 'did-frame-finish-load'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a frame has done navigation."}),"\n",(0,i.jsx)(t.h4,{id:"event-did-start-loading",children:"Event: 'did-start-loading'"}),"\n",(0,i.jsx)(t.p,{children:"Corresponds to the points in time when the spinner of the tab started spinning."}),"\n",(0,i.jsx)(t.h4,{id:"event-did-stop-loading",children:"Event: 'did-stop-loading'"}),"\n",(0,i.jsx)(t.p,{children:"Corresponds to the points in time when the spinner of the tab stopped spinning."}),"\n",(0,i.jsx)(t.h4,{id:"event-dom-ready",children:"Event: 'dom-ready'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the document in the top-level frame is loaded."}),"\n",(0,i.jsx)(t.h4,{id:"event-page-title-updated",children:"Event: 'page-title-updated'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"title"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"explicitSet"})," boolean"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Fired when page title is set during navigation. ",(0,i.jsx)(t.code,{children:"explicitSet"})," is false when\ntitle is synthesized from file url."]}),"\n",(0,i.jsx)(t.h4,{id:"event-page-favicon-updated",children:"Event: 'page-favicon-updated'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"favicons"})," string[] - Array of URLs."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when page receives favicon urls."}),"\n",(0,i.jsx)(t.h4,{id:"event-content-bounds-updated",children:"Event: 'content-bounds-updated'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"bounds"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/rectangle",title:"Rectangle",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Rectangle Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}}],"position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}},{"type":"text","value":" number - The x coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":10,"column":6,"offset":110},"end":{"line":10,"column":85,"offset":189}}}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":10,"column":85,"offset":189}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}}],"position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}},{"type":"text","value":" number - The y coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":11,"column":6,"offset":195},"end":{"line":11,"column":85,"offset":274}}}],"position":{"start":{"line":11,"column":1,"offset":190},"end":{"line":11,"column":85,"offset":274}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}}],"position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}},{"type":"text","value":" number - The width of the rectangle (must be an integer).","position":{"start":{"line":12,"column":10,"offset":284},"end":{"line":12,"column":68,"offset":342}}}],"position":{"start":{"line":12,"column":1,"offset":275},"end":{"line":12,"column":68,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}}],"position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}},{"type":"text","value":" number - The height of the rectangle (must be an integer).","position":{"start":{"line":13,"column":11,"offset":353},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":13,"column":1,"offset":343},"end":{"line":13,"column":70,"offset":412}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":14,"column":1,"offset":413}}}'})," - requested new content bounds"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the page calls ",(0,i.jsx)(t.code,{children:"window.moveTo"}),", ",(0,i.jsx)(t.code,{children:"window.resizeTo"})," or related APIs."]}),"\n",(0,i.jsxs)(t.p,{children:["By default, this will move the window. To prevent that behavior, call\n",(0,i.jsx)(t.code,{children:"event.preventDefault()"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-create-window",children:"Event: 'did-create-window'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"window"})," BrowserWindow"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - URL for the created window."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameName"})," string - Name given to the created window in the\n",(0,i.jsx)(t.code,{children:"window.open()"})," call."]}),"\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/structures/browser-window-options",children:"BrowserWindowConstructorOptions"})," - The options used to create the\nBrowserWindow. They are merged in increasing precedence: parsed options\nfrom the ",(0,i.jsx)(t.code,{children:"features"})," string from ",(0,i.jsx)(t.code,{children:"window.open()"}),", security-related\nwebPreferences inherited from the parent, and options given by\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#contentssetwindowopenhandlerhandler",children:(0,i.jsx)(t.code,{children:"webContents.setWindowOpenHandler"})}),".\nUnrecognized options are not filtered out."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"referrer"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/referrer",title:"Referrer",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Referrer Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"url","position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}}],"position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}},{"type":"text","value":" string - HTTP Referrer URL.","position":{"start":{"line":10,"column":8,"offset":109},"end":{"line":10,"column":36,"offset":137}}}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":10,"column":36,"offset":137}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"policy","position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}}],"position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":11,"column":11,"offset":148},"end":{"line":11,"column":28,"offset":165}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"default","position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}}],"position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":37,"offset":174},"end":{"line":11,"column":39,"offset":176}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"unsafe-url","position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}}],"position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":51,"offset":188},"end":{"line":12,"column":1,"offset":190}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer-when-downgrade","position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}}],"position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":31,"offset":220},"end":{"line":12,"column":33,"offset":222}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer","position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}}],"position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":46,"offset":235},"end":{"line":12,"column":48,"offset":237}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"origin","position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}}],"position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":56,"offset":245},"end":{"line":13,"column":1,"offset":247}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin-when-cross-origin","position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}}],"position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":36,"offset":282},"end":{"line":13,"column":38,"offset":284}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"same-origin","position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}}],"position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}},{"type":"text","value":" or ","position":{"start":{"line":13,"column":51,"offset":297},"end":{"line":13,"column":55,"offset":301}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin","position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}}],"position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}},{"type":"text","value":".\\nSee the ","position":{"start":{"line":13,"column":70,"offset":316},"end":{"line":14,"column":11,"offset":328}}},{"type":"element","tagName":"a","properties":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy"},"children":[{"type":"text","value":"Referrer-Policy spec","position":{"start":{"line":14,"column":12,"offset":329},"end":{"line":14,"column":32,"offset":349}}}],"position":{"start":{"line":14,"column":11,"offset":328},"end":{"line":14,"column":36,"offset":353}}},{"type":"text","value":" for more details on the\\nmeaning of these values.","position":{"start":{"line":14,"column":36,"offset":353},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":11,"column":1,"offset":138},"end":{"line":15,"column":27,"offset":404}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":18,"column":1,"offset":485}}}'})," - The referrer that will be\npassed to the new window. May or may not result in the ",(0,i.jsx)(t.code,{children:"Referer"})," header\nbeing sent, depending on the referrer policy."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"postBody"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/post-body",title:"PostBody",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"PostBody Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"data","position":{"start":{"line":10,"column":3,"offset":105},"end":{"line":10,"column":9,"offset":111}}}],"position":{"start":{"line":10,"column":3,"offset":105},"end":{"line":10,"column":9,"offset":111}}},{"type":"text","value":" (","position":{"start":{"line":10,"column":9,"offset":111},"end":{"line":10,"column":11,"offset":113}}},{"type":"element",

1"tagName":"a","properties":{"href":"/docs/latest/api/structures/upload-raw-data"},"children":[{"type":"text","value":"UploadRawData"}]},{"type":"text","value":" | ","position":{"start":{"line":10,"column":46,"offset":148},"end":{"line":10,"column":49,"offset":151}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/upload-file"},"children":[{"type":"text","value":"UploadFile"}]},{"type":"text","value":")[] - The post data to be sent to the\\nnew window.","position":{"start":{"line":10,"column":77,"offset":179},"end":{"line":11,"column":14,"offset":230}}}],"position":{"start":{"line":10,"column":1,"offset":103},"end":{"line":11,"column":14,"offset":230}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contentType","position":{"start":{"line":12,"column":3,"offset":233},"end":{"line":12,"column":16,"offset":246}}}],"position":{"start":{"line":12,"column":3,"offset":233},"end":{"line":12,"column":16,"offset":246}}},{"type":"text","value":" string - The ","position":{"start":{"line":12,"column":16,"offset":246},"end":{"line":12,"column":30,"offset":260}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"content-type","position":{"start":{"line":12,"column":30,"offset":260},"end":{"line":12,"column":44,"offset":274}}}],"position":{"start":{"line":12,"column":30,"offset":260},"end":{"line":12,"column":44,"offset":274}}},{"type":"text","value":" header used for the data. One of\\n","position":{"start":{"line":12,"column":44,"offset":274},"end":{"line":13,"column":1,"offset":308}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"application/x-www-form-urlencoded","position":{"start":{"line":13,"column":3,"offset":310},"end":{"line":13,"column":38,"offset":345}}}],"position":{"start":{"line":13,"column":3,"offset":310},"end":{"line":13,"column":38,"offset":345}}},{"type":"text","value":" or ","position":{"start":{"line":13,"column":38,"offset":345},"end":{"line":13,"column":42,"offset":349}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"multipart/form-data","position":{"start":{"line":13,"column":42,"offset":349},"end":{"line":13,"column":63,"offset":370}}}],"position":{"start":{"line":13,"column":42,"offset":349},"end":{"line":13,"column":63,"offset":370}}},{"type":"text","value":". Corresponds to\\nthe ","position":{"start":{"line":13,"column":63,"offset":370},"end":{"line":14,"column":7,"offset":393}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"enctype","position":{"start":{"line":14,"column":7,"offset":393},"end":{"line":14,"column":16,"offset":402}}}],"position":{"start":{"line":14,"column":7,"offset":393},"end":{"line":14,"column":16,"offset":402}}},{"type":"text","value":" attribute of the submitted HTML form.","position":{"start":{"line":14,"column":16,"offset":402},"end":{"line":14,"column":54,"offset":440}}}],"position":{"start":{"line":12,"column":1,"offset":231},"end":{"line":14,"column":54,"offset":440}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"boundary","position":{"start":{"line":15,"column":3,"offset":443},"end":{"line":15,"column":13,"offset":453}}}],"position":{"start":{"line":15,"column":3,"offset":443},"end":{"line":15,"column":13,"offset":453}}},{"type":"text","value":" string (optional) - The boundary used to separate multiple parts of\\nthe message. Only valid when ","position":{"start":{"line":15,"column":13,"offset":453},"end":{"line":16,"column":32,"offset":553}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contentType","position":{"start":{"line":16,"column":32,"offset":553},"end":{"line":16,"column":45,"offset":566}}}],"position":{"start":{"line":16,"column":32,"offset":553},"end":{"line":16,"column":45,"offset":566}}},{"type":"text","value":" is ","position":{"start":{"line":16,"column":45,"offset":566},"end":{"line":16,"column":49,"offset":570}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"multipart/form-data","position":{"start":{"line":16,"column":49,"offset":570},"end":{"line":16,"column":70,"offset":591}}}],"position":{"start":{"line":16,"column":49,"offset":570},"end":{"line":16,"column":70,"offset":591}}},{"type":"text","value":".","position":{"start":{"line":16,"column":70,"offset":591},"end":{"line":16,"column":71,"offset":592}}}],"position":{"start":{"line":15,"column":1,"offset":441},"end":{"line":16,"column":71,"offset":592}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":103},"end":{"line":16,"column":71,"offset":592}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":17,"column":1,"offset":593}}}'})," (optional) - The post data\nthat will be sent to the new window, along with the appropriate headers\nthat will be set. If no post data is to be sent, the value will be ",(0,i.jsx)(t.code,{children:"null"}),".\nOnly defined when the window is being created by a form that set\n",(0,i.jsx)(t.code,{children:"target=_blank"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"disposition"})," string - Can be ",(0,i.jsx)(t.code,{children:"default"}),", ",(0,i.jsx)(t.code,{children:"foreground-tab"}),",\n",(0,i.jsx)(t.code,{children:"background-tab"}),", ",(0,i.jsx)(t.code,{children:"new-window"})," or ",(0,i.jsx)(t.code,{children:"other"}

1),". Corresponds to the manner\nan associated link was clicked. See Chromium's\n",(0,i.jsx)(t.a,{href:"https://source.chromium.org/chromium/chromium/src/+/main:ui/base/window_open_disposition.h",children:"WindowOpenDisposition"}),".","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"default"})," - Indicates Chromium deems in-window navigation valid\nfor a window open call."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"foreground-tab"})," - Corresponds to a left click or shift + middle click."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"background-tab"})," - Corresponds to a middle click or ctrl/cmd + click."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"new-window"})," - Corresponds to a shift + left click."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"other"})," - A catch-all for the remaining Chromium dispositions not\nhandled by Electron."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted ",(0,i.jsx)(t.em,{children:"after"})," successful creation of a window via ",(0,i.jsx)(t.code,{children:"window.open"})," in the renderer.\nNot emitted if the creation of the window is canceled from\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#contentssetwindowopenhandlerhandler",children:(0,i.jsx)(t.code,{children:"webContents.setWindowOpenHandler"})}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["See ",(0,i.jsx)(t.a,{href:"/docs/latest/api/window-open",children:(0,i.jsx)(t.code,{children:"window.open()"})})," for more details and how to use this in conjunction with ",(0,i.jsx)(t.code,{children:"webContents.setWindowOpenHandler"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-will-navigate",children:"Event: 'will-navigate'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - The URL the frame is navigating to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isSameDocument"})," boolean - This event does not fire for same document navigations using window.history api and reference fragment navigations.\nThis property is always set to ",(0,i.jsx)(t.code,{children:"false"})," for this event."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean - True if the navigation is taking place in a main frame."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - The frame to be navigated.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"initiator"})," WebFrameMain | null (optional) - The frame which initiated the\nnavigation. This can be a parent frame (e.g. via ",(0,i.jsx)(t.code,{children:"window.open"})," with a\nframe's name), a child frame (e.g. an unsandboxed iframe navigating its\nparent via ",(0,i.jsx)(t.code,{children:'<a target="_top">'}),"), or null if the navigation was not initiated\nby a frame. This can also be null if the initiating frame was deleted before\nthe event was emitted."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isInPlace"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a user or the page wants to start navigation on the main frame. It can happen when\nthe ",(0,i.jsx)(t.code,{children:"window.location"})," object is changed or a user clicks a link in the page."]}),"\n",(0,i.jsxs)(t.p,{children:["This event will not emit when the navigation is started programmatically with\nAPIs like ",(0,i.jsx)(t.code,{children:"webContents.loadURL"})," and ",(0,i.jsx)(t.code,{children:"webContents.back"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["It is also not emitted for in-page navigations, such as clicking anchor links\nor updating the ",(0,i.jsx)(t.code,{children:"window.location.hash"}),". Use ",(0,i.jsx)(t.code,{children:"did-navigate-in-page"})," event for\nthis purpose."]}),"\n",(0,i.jsxs)(t.p,{children:["Calling ",(0,i.jsx)(t.code,{children:"event.preventDefault()"})," will prevent the navigation."]}),"\n",(0,i.jsx)(t.h4,{id:"event-will-frame-navigate",children:"Event: 'will-frame-navigate'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - The URL the frame is navigating to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isSameDocument"})," boolean - This event does not fire for same document navigations using window.history api and reference fragment navigations.\nThis property is always set to ",(0,i.jsx)(t.code,{children:"false"})," for this event."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean - True if the navigation is taking place in a main frame."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - The frame to be navigated.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"initiator"})," WebFrameMain | null (optional) - The frame which initiated the\nnavigation. This can be a parent frame (e.g. via ",(0,i.jsx)(t.code,{children:"window.open"})," with a\nframe's name), a child frame (e.g. an unsandboxed iframe navigating its\nparent via ",(0,i.jsx)(t.code,{children:'<a target="_top">'}),"), or null if the navigation was not initiated\nby a frame. This can also be null if the initiating frame was deleted before\nthe event was emitted."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a user or the page wants to start navigation in any frame. It can happen when\nthe ",(0,i.jsx)(t.code,{children:"window.location"})," object is changed or a user clicks a link in the page."]}),"\n",(0,i.jsxs)(t.p,{children:["Unlike ",(0,i.jsx)(t.code,{children:"will-navigate"}),", ",(0,i.jsx)(t.code,{children:"will-frame-navigate"}

1)," is fired when the main frame or any of its subframes attempts to navigate. When the navigation event comes from the main frame, ",(0,i.jsx)(t.code,{children:"isMainFrame"})," will be ",(0,i.jsx)(t.code,{children:"true"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["This event will not emit when the navigation is started programmatically with\nAPIs like ",(0,i.jsx)(t.code,{children:"webContents.loadURL"})," and ",(0,i.jsx)(t.code,{children:"webContents.back"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["It is also not emitted for in-page navigations, such as clicking anchor links\nor updating the ",(0,i.jsx)(t.code,{children:"window.location.hash"}),". Use ",(0,i.jsx)(t.code,{children:"did-navigate-in-page"})," event for\nthis purpose."]}),"\n",(0,i.jsxs)(t.p,{children:["Calling ",(0,i.jsx)(t.code,{children:"event.preventDefault()"})," will prevent the navigation."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-start-navigation",children:"Event: 'did-start-navigation'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - The URL the frame is navigating to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isSameDocument"})," boolean - Whether the navigation happened without changing\ndocument. Examples of same document navigations are reference fragment\nnavigations, pushState/replaceState, and same page history navigation."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean - True if the navigation is taking place in a main frame."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - The frame to be navigated.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"initiator"})," WebFrameMain | null (optional) - The frame which initiated the\nnavigation. This can be a parent frame (e.g. via ",(0,i.jsx)(t.code,{children:"window.open"})," with a\nframe's name), a child frame (e.g. an unsandboxed iframe navigating its\nparent via ",(0,i.jsx)(t.code,{children:'<a target="_top">'}),"), or null if the navigation was not initiated\nby a frame. This can also be null if the initiating frame was deleted before\nthe event was emitted."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isInPlace"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when any frame (including main) starts navigating."}),"\n",(0,i.jsx)(t.h4,{id:"event-will-redirect",children:"Event: 'will-redirect'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - The URL the frame is navigating to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isSameDocument"})," boolean - Whether the navigation happened without changing\ndocument. Examples of same document navigations are reference fragment\nnavigations, pushState/replaceState, and same page history navigation."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean - True if the navigation is taking place in a main frame."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - The frame to be navigated.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"initiator"})," WebFrameMain | null (optional) - The frame which initiated the\nnavigation. This can be a parent frame (e.g. via ",(0,i.jsx)(t.code,{children:"window.open"})," with a\nframe's name), a child frame (e.g. an unsandboxed iframe navigating its\nparent via ",(0,i.jsx)(t.code,{children:'<a target="_top">'}),"), or null if the navigation was not initiated\nby a frame. This can also be null if the initiating frame was deleted before\nthe event was emitted."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isInPlace"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a server side redirect occurs during navigation.  For example a 302\nredirect."}),"\n",(0,i.jsxs)(t.p,{children:["This event will be emitted after ",(0,i.jsx)(t.code,{children:"did-start-navigation"})," and always before the\n",(0,i.jsx)(t.code,{children:"did-redirect-navigation"})," event for the same navigation."]}),"\n",(0,i.jsxs)(t.p,{children:["Calling ",(0,i.jsx)(t.code,{children:"event.preventDefault()"})," will prevent the navigation (not just the\nredirect)."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-redirect-navigation",children:"Event: 'did-redirect-navigation'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - The URL the frame is navigating to."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isSameDocument"})," boolean - Whether the navigation happened without changing\ndocument. Examples of same document navigations are reference fragment\nnavigations, pushState/replaceState, and same page history navigation."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean - True if the navigation is taking place in a main frame."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - The frame to be navigated.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"initiator"})," WebFrameMain | null (optional) - The frame which initiated the\nnavigation. This can be a parent frame (e.g. via ",(0,i.jsx)(t.code,{children:"window.open"})," with a\nframe's name), a child frame (e.g. an unsandboxed iframe navigating its\nparent via ",(0,i.jsx)(t.code,{children:'<a target="_top">'}),"), or null if the navigation was not initiated\nby a frame. This can also be null if the initiating frame was deleted before\nthe event was emitted."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isInPlace"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted after a server side redirect occurs during navigation.  For example a 302\nredirect."}),"\n",(0,i.jsxs)(t.p,{children:["This event cannot be prevented, if you want to prevent redirects you should\ncheck out the ",(0,i.jsx)(t.code,{children:"will-redirect"})," event above."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-navigate",children:"Event: 'did-navigate'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"httpResponseCode"})," Integer - -1 for non HTTP navigations"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"httpStatusText"})," string - empty for non HTTP navigations"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a main frame navigation is done."}),"\n",(0,i.jsxs)(t.p,{children:["This event is not emitted for in-page navigations, such as clicking anchor links\nor updating the ",(0,i.jsx)(t.code,{children:"window.location.hash"}),". Use ",(0,i.jsx)(t.code,{children:"did-navigate-in-page"})," event for\nthis purpose."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-frame-navigate",children:"Event: 'did-frame-navigate'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"httpResponseCode"})," Integer - -1 for non HTTP navigations"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"httpStatusText"})," string - empty for non HTTP navigations,"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when any frame navigation is done."}),"\n",(0,i.jsxs)(t.p,{children:["This event is not emitted for in-page navigations, such as clicking anchor links\nor updating the ",(0,i.jsx)(t.code,{children:"window.location.hash"}),". Use ",(0,i.jsx)(t.code,{children:"did-navigate-in-page"})," event for\nthis purpose."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-navigate-in-page",children:"Event: 'did-navigate-in-page'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameProcessId"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameRoutingId"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when an in-page navigation happened in any frame."}

1),"\n",(0,i.jsxs)(t.p,{children:["When in-page navigation happens, the page URL changes but does not cause\nnavigation outside of the page. Examples of this occurring are when anchor links\nare clicked or when the DOM ",(0,i.jsx)(t.code,{children:"hashchange"})," event is triggered."]}),"\n",(0,i.jsx)(t.h4,{id:"event-will-prevent-unload",children:"Event: 'will-prevent-unload'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a ",(0,i.jsx)(t.code,{children:"beforeunload"})," event handler is attempting to cancel a page unload."]}),"\n",(0,i.jsxs)(t.p,{children:["Calling ",(0,i.jsx)(t.code,{children:"event.preventDefault()"})," will ignore the ",(0,i.jsx)(t.code,{children:"beforeunload"})," event handler\nand allow the page to be unloaded."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow, dialog } = require('electron')\n\nconst win = new BrowserWindow({ width: 800, height: 600 })\nwin.webContents.on('will-prevent-unload', (event) => {\n  const choice = dialog.showMessageBoxSync(win, {\n    type: 'question',\n    buttons: ['Leave', 'Stay'],\n    title: 'Do you want to leave this site?',\n    message: 'Changes you made may not be saved.',\n    defaultId: 0,\n    cancelId: 1\n  })\n  const leave = choice === 0\n  if (leave) {\n    event.preventDefault()\n  }\n})\n"})}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["This will be emitted for ",(0,i.jsx)(t.code,{children:"BrowserViews"})," but will ",(0,i.jsx)(t.em,{children:"not"})," be respected - this is because we have chosen not to tie the ",(0,i.jsx)(t.code,{children:"BrowserView"})," lifecycle to its owning BrowserWindow should one exist per the ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event",children:"specification"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"event-render-process-gone",children:"Event: 'render-process-gone'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/render-process-gone-details",title:"RenderProcessGoneDetails",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"RenderProcessGoneDetails Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"reason","position":{"start":{"line":10,"column":3,"offset":155},"end":{"line":10,"column":11,"offset":163}}}],"position":{"start":{"line":10,"column":3,"offset":155},"end":{"line":10,"column":11,"offset":163}}},{"type":"text","value":" string - The reason the render process is gone.  Possible values:","position":{"start":{"line":10,"column":11,"offset":163},"end":{"line":10,"column":77,"offset":229}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"clean-exit","position":{"start":{"line":11,"column":5,"offset":234},"end":{"line":11,"column":17,"offset":246}}}],"position":{"start":{"line":11,"column":5,"offset":234},"end":{"line":11,"column":17,"offset":246}}},{"type":"text","value":" - Process exited with an exit code of zero","position":{"start":{"line":11,"column":17,"offset":246},"end":{"line":11,"column":60,"offset":289}}}],"position":{"start":{"line":11,"column":3,"offset":232},"end":{"line":11,"column":60,"offset":289}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"abnormal-exit","position":{"start":{"line":12,"column":5,"offset":294},"end":{"line":12,"column":20,"offset":309}}}],"position":{"start":{"line":12,"column":5,"offset":294},"end":{"line":12,"column":20,"offset":309}}}

1,{"type":"text","value":" - Process exited with a non-zero exit code","position":{"start":{"line":12,"column":20,"offset":309},"end":{"line":12,"column":63,"offset":352}}}],"position":{"start":{"line":12,"column":3,"offset":292},"end":{"line":12,"column":63,"offset":352}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"killed","position":{"start":{"line":13,"column":5,"offset":357},"end":{"line":13,"column":13,"offset":365}}}],"position":{"start":{"line":13,"column":5,"offset":357},"end":{"line":13,"column":13,"offset":365}}},{"type":"text","value":" - Process was sent a SIGTERM or otherwise killed externally","position":{"start":{"line":13,"column":13,"offset":365},"end":{"line":13,"column":73,"offset":425}}}],"position":{"start":{"line":13,"column":3,"offset":355},"end":{"line":13,"column":73,"offset":425}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"crashed","position":{"start":{"line":14,"column":5,"offset":430},"end":{"line":14,"column":14,"offset":439}}}],"position":{"start":{"line":14,"column":5,"offset":430},"end":{"line":14,"column":14,"offset":439}}},{"type":"text","value":" - Process crashed","position":{"start":{"line":14,"column":14,"offset":439},"end":{"line":14,"column":32,"offset":457}}}],"position":{"start":{"line":14,"column":3,"offset":428},"end":{"line":14,"column":32,"offset":457}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"oom","position":{"start":{"line":15,"column":5,"offset":462},"end":{"line":15,"column":10,"offset":467}}}],"position":{"start":{"line":15,"column":5,"offset":462},"end":{"line":15,"column":10,"offset":467}}},{"type":"text","value":" - Process ran out of memory","position":{"start":{"line":15,"column":10,"offset":467},"end":{"line":15,"column":38,"offset":495}}}],"position":{"start":{"line":15,"column":3,"offset":460},"end":{"line":15,"column":38,"offset":495}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"launch-failed","position":{"start":{"line":16,"column":5,"offset":500},"end":{"line":16,"column":20,"offset":515}}}],"position":{"start":{"line":16,"column":5,"offset":500},"end":{"line":16,"column":20,"offset":515}}},{"type":"text","value":" - Process never successfully launched","position":{"start":{"line":16,"column":20,"offset":515},"end":{"line":16,"column":58,"offset":553}}}],"position":{"start":{"line":16,"column":3,"offset":498},"end":{"line":16,"column":58,"offset":553}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"integrity-failure","position":{"start":{"line":17,"column":5,"offset":558},"end":{"line":17,"column":24,"offset":577}}}],"position":{"start":{"line":17,"column":5,"offset":558},"end":{"line":17,"column":24,"offset":577}}},{"type":"text","value":" - Windows code integrity checks failed","position":{"start":{"line":17,"column":24,"offset":577},"end":{"line":17,"column":63,"offset":616}}}],"position":{"start":{"line":17,"column":3,"offset":556},"end":{"line":17,"column":63,"offset":616}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"memory-eviction","position":{"start":{"line":18,"column":5,"offset":621},"end":{"line":18,"column":22,"offset":638}}}],"position":{"start":{"line":18,"column":5,"offset":621},"end":{"line":18,"column":22,"offset":638}}},{"type":"text","value":" - Process proactively terminated to prevent a future out-of-memory (OOM) situation","position":{"start":{"line":18,"column":22,"offset":638}

1,"end":{"line":18,"column":105,"offset":721}}}],"position":{"start":{"line":18,"column":3,"offset":619},"end":{"line":18,"column":105,"offset":721}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":11,"column":3,"offset":232},"end":{"line":18,"column":105,"offset":721}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":153},"end":{"line":18,"column":105,"offset":721}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"exitCode","position":{"start":{"line":19,"column":3,"offset":724},"end":{"line":19,"column":13,"offset":734}}}],"position":{"start":{"line":19,"column":3,"offset":724},"end":{"line":19,"column":13,"offset":734}}},{"type":"text","value":" Integer - The exit code of the process, unless ","position":{"start":{"line":19,"column":13,"offset":734},"end":{"line":19,"column":61,"offset":782}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"reason","position":{"start":{"line":19,"column":61,"offset":782},"end":{"line":19,"column":69,"offset":790}}}],"position":{"start":{"line":19,"column":61,"offset":782},"end":{"line":19,"column":69,"offset":790}}},{"type":"text","value":" is\\n","position":{"start":{"line":19,"column":69,"offset":790},"end":{"line":20,"column":1,"offset":794}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"launch-failed","position":{"start":{"line":20,"column":3,"offset":796},"end":{"line":20,"column":18,"offset":811}}}],"position":{"start":{"line":20,"column":3,"offset":796},"end":{"line":20,"column":18,"offset":811}}},{"type":"text","value":", in which case ","position":{"start":{"line":20,"column":18,"offset":811},"end":{"line":20,"column":34,"offset":827}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"exitCode","position":{"start":{"line":20,"column":34,"offset":827},"end":{"line":20,"column":44,"offset":837}}}],"position":{"start":{"line":20,"column":34,"offset":827},"end":{"line":20,"column":44,"offset":837}}},{"type":"text","value":" will be a platform-specific\\nlaunch failure error code.","position":{"start":{"line":20,"column":44,"offset":837},"end":{"line":21,"column":29,"offset":894}}}],"position":{"start":{"line":19,"column":1,"offset":722},"end":{"line":21,"column":29,"offset":894}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":153},"end":{"line":21,"column":29,"offset":894}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":22,"column":1,"offset":895}}}'})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the renderer process unexpectedly disappears.  This is normally\nbecause it was crashed or killed."}),"\n",(0,i.jsx)(t.h4,{id:"event-unresponsive",children:"Event: 'unresponsive'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the web page becomes unresponsive."}),"\n",(0,i.jsx)(t.h4,{id:"event-responsive",children:"Event: 'responsive'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the unresponsive web page becomes responsive again."}),"\n",(0,i.jsx)(t.h4,{id:"event-destroyed",children:"Event: 'destroyed'"}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when ",(0,i.jsx)(t.code,{children:"webContents"})," is destroyed."]}),"\n",(0,i.jsx)(t.h4,{id:"event-input-event",children:"Event: 'input-event'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"inputEvent"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/input-event",title:"InputEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"InputEvent Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}}],"position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":10,"column":9,"offset":117},"end":{"line":10,"column":26,"offset":134}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"undefined","position":{"start":{"line":10,"column":26,"offset":134},"end":{"line":10,"column":37,"offset":145}}}],"position":{"start":{"line":10,"column":26,"offset":134},"end":{"line":10,"column":37,"offset":145}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":37,"offset":145},"end":{"line":10,"column":39,"offset":147}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseDown","position":{"start":{"line":10,"column":39,"offset":147},"end":{"line":10,"column":50,"offset":158}}}],"position":{"start":{"line":10,"column":39,"offset":147},"end":{"line":10,"column":50,"offset":158}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":50,"offset":158},"end":{"line":10,"column":52,"offset":160}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseUp","position":{"start":{"line":10,"column":52,"offset":160},"end":{"line":10,"column":61,"offset":169}}}],"position":{"start":{"line":10,"column":52,"offset":160},"end":{"line":10,"column":61,"offset":169}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":61,"offset":169},"end":{"line":10,"column":63,"offset":171}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseMove","position":{"start":{"line":10,"column":63,"offset":171},"end":{"line":10,"column":74,"offset":182}}}],"position":{"start":{"line":10,"column":63,"offset":171},"end":{"line":10,"column":74,"offset":182}}},{"type":"text","value":",\\n","position":{"start":{"line":10,"column":74,"offset":182},"end":{"line":11,"column":1,"offset":184}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseEnter","position":{"start":{"line":11,"column":3,"offset":186},"end":{"line":11,"column":15,"offset":198}}}],"position":{"start":{"line":11,"column":3,"offset":186},"end":{"line":11,"column":15,"offset":198}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":15,"offset":198},"end":{"line":11,"column":17,"offset":200}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseLeave","position":{"start":{"line":11,"column":17,"offset":200},"end":{"line":11,"column":29,"offset":212}}}],"position":{"start":{"line":11,"column":17,"offset":200},"end":{"line":11,"column":29,"offset":212}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":29,"offset":212},"end":{"line":11,"column":31,"offset":214}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contextMenu","position":{"start":{"line":11,"column":31,"offset":214},"end":{"line":11,"column":44,"offset":227}}}],"position":{"start":{"line":11,"column":31,"offset":214},"end":{"line":11,"column":44,"offset":227}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":44,"offset":227},"end":{"line":11,"column":46,"offset":229}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseWheel","position":{"start":{"line":11,"column":46,"offset":229},"end":{"line":11,"column":58,"offset":241}}}],"position":{"start":{"line":11,"column":46,"offset":229},"end":{"line":11,"column":58,"offset":241}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":58,"offset":241},"end":{"line":11,"column":60,"offset":243}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rawKeyDown","position":{"start":{"line":11,"column":60,"offset":243},"end":{"line":11,"column":72,"offset":255}}}],"position":{"start":{"line":11,"column":60,"offset":243},"end":{"line":11,"column":72,"offset":255}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":72,"offset":255},"end":{"line":12,"column":1,"offset":257}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyDown","position":{"start":{"line":12,"column":3,"offset":259},"end":{"line":12,"column":12,"offset":268}}}],"position":{"start":{"line":12,"column":3,"offset":259},"end":{"line":12,"column":12,"offset":268}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":12,"offset":268},"end":{"line":12,"column":14,"offset":270}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyUp","position":{"start":{"line":12,"column":14,"offset":270},"end":{"line":12,"column":21,"offset":277}}}],"position":{"start":{"line":12,"column":14,"offset":270},"end":{"line":12,"column":21,"offset":277}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":21,"offset":277},"end":{"line":12,"column":23,"offset":279}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"char","position":{"start":{"line":12,"column":23,"offset":279},"end":{"line":12,"column":29,"offset":285}}}],"position":{"start":{"line":12,"column":23,"offset":279},"end":{"line":12,"column":29,"offset":285}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":29,"offset":285},"end":{"line":12,"column":31,"offset":287}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollBegin","position":{"start":{"line":12,"column":31,"offset":287},"end":{"line":12,"column":51,"offset":307}}}],"position":{"start":{"line":12,"column":31,"offset":287},"end":{"line":12,"column":51,"offset":307}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":51,"offset":307},"end":{"line":12,"column":53,"offset":309}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollEnd","position":{"start":{"line":12,"column":53,"offset":309},"end":{"line":12,"column":71,"offset":327}}}],"position":{"start":{"line":12,"column":53,"offset":309},"end":{"line":12,"column":71,"offset":327}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":71,"offset":327},"end":{"line":13,"column":1,"offset":329}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollUpdate","position":{"start":{"line":13,"column":3,"offset":33

11},"end":{"line":13,"column":24,"offset":352}}}],"position":{"start":{"line":13,"column":3,"offset":331},"end":{"line":13,"column":24,"offset":352}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":24,"offset":352},"end":{"line":13,"column":26,"offset":354}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureFlingStart","position":{"start":{"line":13,"column":26,"offset":354},"end":{"line":13,"column":45,"offset":373}}}],"position":{"start":{"line":13,"column":26,"offset":354},"end":{"line":13,"column":45,"offset":373}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":45,"offset":373},"end":{"line":13,"column":47,"offset":375}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureFlingCancel","position":{"start":{"line":13,"column":47,"offset":375},"end":{"line":13,"column":67,"offset":395}}}],"position":{"start":{"line":13,"column":47,"offset":375},"end":{"line":13,"column":67,"offset":395}}},{"type":"text","value":",\\n","position":{"start":{"line":13,"column":67,"offset":395},"end":{"line":14,"column":1,"offset":397}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchBegin","position":{"start":{"line":14,"column":3,"offset":399},"end":{"line":14,"column":22,"offset":418}}}],"position":{"start":{"line":14,"column":3,"offset":399},"end":{"line":14,"column":22,"offset":418}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":22,"offset":418},"end":{"line":14,"column":24,"offset":420}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchEnd","position":{"start":{"line":14,"column":24,"offset":420},"end":{"line":14,"column":41,"offset":437}}}],"position":{"start":{"line":14,"column":24,"offset":420},"end":{"line":14,"column":41,"offset":437}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":41,"offset":437},"end":{"line":14,"column":43,"offset":439}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchUpdate","position":{"start":{"line":14,"column":43,"offset":439},"end":{"line":14,"column":63,"offset":459}}}],"position":{"start":{"line":14,"column":43,"offset":439},"end":{"line":14,"column":63,"offset":459}}},{"type":"text","value":",\\n","position":{"start":{"line":14,"column":63,"offset":459},"end":{"line":15,"column":1,"offset":461}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapDown","position":{"start":{"line":15,"column":3,"offset":463},"end":{"line":15,"column":19,"offset":479}}}],"position":{"start":{"line":15,"column":3,"offset":463},"end":{"line":15,"column":19,"offset":479}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":19,"offset":479},"end":{"line":15,"column":21,"offset":481}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureShowPress","position":{"start":{"line":15,"column":21,"offset":481},"end":{"line":15,"column":39,"offset":499}}}],"position":{"start":{"line":15,"column":21,"offset":481},"end":{"line":15,"column":39,"offset":499}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":39,"offset":499},"end":{"line":15,"column":41,"offset":501}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTap","position":{"start":{"line":15,"column":41,"offset":501},"end":{"line":15,"column":53,"offset":513}}}],"position":{"start":{"line":15,"column":41,"offset":501},"end":{"line":15,"column":53,"offset":513}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":53,"offset":513},"end":{"line":15,"column":55,"offset":515}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapCancel","position":{"start":{"line":15,"column":55,"offset":515},"end":{"line":15,"column":73,"offset":533}}}],"position":{"start":{"line":15,"column":55,"offset":515},"end":{"line":15,"column":73,"offset":533}}},{"type":"text","value":",\\n","position":{"start":{"line":15,"column":73,"offset":533},"end":{"line":16,"column":1,"offset":535}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureShortPress","position":{"start":{"line":16,"column":3,"offset":537},"end":{"line":16,"column":22,"offset":556}}}],"position":{"start":{"line":16,"column":3,"offset":537},"end":{"line":16,"column":22,"offset":556}}},{"type":"text","value":", ","position":{"start":{"line":16,"column":22,"offset":556},"end":{"line":16,"column":24,"offset":558}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureLongPress","position":{"start":{"line":16,"column":24,"offset":558},"end":{"line":16,"column":42,"offset":576}}}],"position":{"start":{"line":16,"column":24,"offset":558},"end":{"line":16,"column":42,"offset":576}}},{"type":"text","value":", ","position":{"start":{"line":16,"column":42,"offset":576},"end":{"line":16,"column":44,"offset":578}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureLongTap","position":{"start":{"line":16,"column":44,"offset":578},"end":{"line":16,"column":60,"offset":594}}}],"position":{"start":{"line":16,"column":44,"offset":578},"end":{"line":16,"column":60,"offset":594}}},{"type":"text","value":",\\n","position":{"start":{"line":16,"column":60,"offset":594},"end":{"line":17,"column":1,"offset":596}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTwoFingerTap","position":{"start":{"line":17,"column":3,"offset":598},"end":{"line":17,"column":24,"offset":619}}}],"position":{"start":{"line":17,"column":3,"offset":598},"end":{"line":17,"column":24,"offset":619}}},{"type":"text","value":", ","position":{"start":{"line":17,"column":24,"offset":619},"end":{"line":17,"column":26,"offset":621}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapUnconfirmed","position":{"start":{"line":17,"column":26,"offset":621},"end":{"line":17,"column":49,"offset":644}}}],"position":{"start":{"line":17,"column":26,"offset":621},"end":{"line":17,"column":49,"offset":644}}},{"type":"text","value":", ","position":{"start":{"line":17,"column":49,"offset":644},"end":{"line":17,"column":51,"offset":646}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureDoubleTap","position":{"start":{"line":17,"column":51,"offset":646},"end":{"line":17,"column":69,"offset":664}}}],"position":{"start":{"line":17,"column":51,"offset":646},"end":{"line":17,"column":69,"offset":664}}},{"type":"text","value":",\\n","position":{"start":{"line":17,"column":69,"offset":664},"end":{"line":18,"column":1,"offset":666}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchStart","position":{"start":{"line":18,"column":3,"offset":668},"end":{"line":18,"column":15,"offset":680}}}],"position":{"start":{"line":18,"column":3,"offset":668},"end":{"line":18,"column":15,"offset":680}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":15,"offset":680},"end":{"line":18,"column":17,"offset":682}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchMove","position":{"start":{"line":18,"column":17,"offset":682},"end":{"line":18,"column":28,"offset":693}}}],"position":{"start":{"line":18,"column":17,"offset":682},"end":{"line":18,"column":28,"offset":693}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":28,"offset":693},"end":{"line":18,"column":30,"offset":695}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchEnd","position":{"start":{"line":18,"column":30,"offset":695},"end":{"line":18,"column":40,"offset":705}}}],"position":{"start":{"line":18,"column":30,"offset":695},"end":{"line":18,"column":40,"offset":705}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":40,"offset":705},"end":{"line":18,"column":42,"offset":707}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchCancel","position":{"start":{"line":18,"column":42,"offset":707},"end":{"line":18,"column":55,"offset":720}}}],"position":{"start":{"line":18,"column":42,"offset":707},"end":{"line":18,"column":55,"offset":720}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":55,"offset":720},"end":{"line":18,"column":57,"offset":722}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchScrollStarted","position":{"start":{"line":18,"column":57,"offset":722},"end":{"line":18,"column":77,"offset":742}}}],"position":{"start":{"line":18,"column":57,"offset":722},"end":{"line":18,"column":77,"offset":742}}},{"type":"text","value":",\\n","position":{"start":{"line":18,"column":77,"offset":742},"end":{"line":19,"column":1,"offset":744}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerDown","position":{"start":{"line":19,"column":3,"offset":746},"end":{"line":19,"column":16,"offset":759}}}],"position":{"start":{"line":19,"column":3,"offset":746},"end":{"line":19,"column":16,"offset":759}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":16,"offset":759},"end":{"line":19,"column":18,"offset":761}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerUp","position":{"start":{"line":19,"column":18,"offset":761},"end":{"line":19,"column":29,"offset":772}}}],"position":{"start":{"line":19,"column":18,"offset":761},"end":{"line":19,"column":29,"offset":772}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":29,"offset":772},"end":{"line":19,"column":31,"offset":774}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerMove","position":{"start":{"line":19,"column":31,"offset":774},"end":{"line":19,"column":44,"offset":787}}}],"position":{"start":{"line":19,"column":31,"offset":774},"end":{"line":19,"column":44,"offset":787}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":44,"offset":787},"end":{"line":19,"column":46,"offset":789}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerRawUpdate","position":{"start":{"line":19,"column":46,"offset":789},"end":{"line":19,"column":64,"offset":807}}}],"position":{"start":{"line":19,"column":46,"offset":789},"end":{"line":19,"column":64,"offset":807}}},{"type":"text","value":",\\n","position":{"start":{"line":19,"column":64,"offset":807},"end":{"line":20,"column":1,"offset":809}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerCancel","position":{"start":{"line":20,"column":3,"offset":811},"end":{"line":20,"column":18,"offset":826}}}],"position":{"start":{"line":20,"column":3,"offset":811},"end":{"line":20,"column":18,"offset":826}}},{"type":"text","value":" or ","position":{"start":{"line":20,"column":18,"offset":826},"end":{"line":20,"column":22,"offset":830}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerCausedUaAction","position":{"start":{"line":20,"column":22,"offset":830},"end":{"line":20,"column":45,"offset":853}}}],"position":{"start":{"line":20,"column":22,"offset":830},"end":{"line":20,"column":45,"offset":853}}},{"type":"text","value":".","position":{"start":{"line":20,"column":45,"offset":853},"end":{"line":20,"column":46,"offset":854}}}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":20,"column":46,"offset":854}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"modifiers","position":{"start":{"line":21,"column":3,"offset":857},"end":{"line":21,"column":14,"offset":868}}}],"position":{"start":{"line":21,"column":3,"offset":857},"end":{"line":21,"column":14,"offset":868}}},{"type":"text","value":" string[] (optional) - An array of modifiers of the event, can\\nbe ","position":{"start":{"line":21,"column":14,"offset":868},"end":{"line":22,"column":6,"offset":936}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"shift","position":{"start":{"line":22,"column":6,"offset":936},"end":{"line":22,"column":13,"offset":943}}}],"position":{"start":{"line":22,"column":6,"offset":936},"end":{"line":22,"column":13,"offset":943}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":13,"offset":943},"end":{"line":22,"column":15,"offset":945}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"control","position":{"start":{"line":22,"column":15,"offset":945},"end":{"line":22,"column":24,"offset":954}}}],"position":{"start":{"line":22,"column":15,"offset":945},"end":{"line":22,"column":24,"offset":954}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":24,"offset":954},"end":{"line":22,"column":26,"offset":956}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ctrl","position":{"start":{"line":22,"column":26,"offset":956},"end":{"line":22,"column":32,"offset":962}}}],"position":{"start":{"line":22,"column":26,"offset":956},"end":{"line":22,"column":32,"offset":962}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":32,"offset":962},"end":{"line":22,"column":34,"offset":964}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"alt","position":{"start":{"line":22,"column":34,"offset":964},"end":{"line":22,"column":39,"offset":969}}}],"position":{"start":{"line":22,"column":34,"offset":964},"end":{"line":22,"column":39,"offset":969}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":39,"offset":969},"end":{"line":22,"column":41,"offset":971}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"meta","position":{"start":{"line":22,"column":41,"offset":971},"end":{"line":22,"column":47,"offset":977}}}],"position":{"start":{"line":22,"column":41,"offset":971},"end":{"line":22,"column":47,"offset":977}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":47,"offset":977},"end":{"line":22,"column":49,"offset":979}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"command","position":{"start":{"line":22,"column":49,"offset":979},"end":{"line":22,"column":58,"offset":988}}}],"position":{"start":{"line":22,"column":49,"offset":979},"end":{"line":22,"column":58,"offset":988}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":58,"offset":988},"end":{"line":22,"column":60,"offset":990}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"cmd","position":{"start":{"line":22,"column":60,"offset":990},"end":{"line":22,"column":65,"offset":995}}}],"position":{"start":{"line":22,"column":60,"offset":990},"end":{"line":22,"column":65,"offset":995}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":65,"offset":995},"end":{"line":22,"column":67,"offset":997}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"iskeypad","position":{"start":{"line":22,"column":67,"offset":997},"end":{"line":22,"column":77,"offset":1007}}}],"position":{"start":{"line":22,"column":67,"offset":997},"end":{"line":22,"column":77,"offset":1007}}},{"type":"text","value":",\\n","position":{"start":{"line":22,"column":77,"offset":1007},"end":{"line":23,"column":1,"offset":1009}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"isautorepeat","position":{"start":{"line":23,"column":3,"offset":1011},"end":{"line":23,"column":17,"offset":1025}}}],"position":{"start":{"line":23,"column":3,"offset":1011},"end":{"line":23,"column":17,"offset":1025}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":17,"offset":1025},"end":{"line":23,"column":19,"offset":1027}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"leftbuttondown","position":{"start":{"line":23,"colum

1n":19,"offset":1027},"end":{"line":23,"column":35,"offset":1043}}}],"position":{"start":{"line":23,"column":19,"offset":1027},"end":{"line":23,"column":35,"offset":1043}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":35,"offset":1043},"end":{"line":23,"column":37,"offset":1045}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"middlebuttondown","position":{"start":{"line":23,"column":37,"offset":1045},"end":{"line":23,"column":55,"offset":1063}}}],"position":{"start":{"line":23,"column":37,"offset":1045},"end":{"line":23,"column":55,"offset":1063}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":55,"offset":1063},"end":{"line":23,"column":57,"offset":1065}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rightbuttondown","position":{"start":{"line":23,"column":57,"offset":1065},"end":{"line":23,"column":74,"offset":1082}}}],"position":{"start":{"line":23,"column":57,"offset":1065},"end":{"line":23,"column":74,"offset":1082}}},{"type":"text","value":",\\n","position":{"start":{"line":23,"column":74,"offset":1082},"end":{"line":24,"column":1,"offset":1084}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"capslock","position":{"start":{"line":24,"column":3,"offset":1086},"end":{"line":24,"column":13,"offset":1096}}}],"position":{"start":{"line":24,"column":3,"offset":1086},"end":{"line":24,"column":13,"offset":1096}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":13,"offset":1096},"end":{"line":24,"column":15,"offset":1098}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"numlock","position":{"start":{"line":24,"column":15,"offset":1098},"end":{"line":24,"column":24,"offset":1107}}}],"position":{"start":{"line":24,"column":15,"offset":1098},"end":{"line":24,"column":24,"offset":1107}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":24,"offset":1107},"end":{"line":24,"column":26,"offset":1109}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"left","position":{"start":{"line":24,"column":26,"offset":1109},"end":{"line":24,"column":32,"offset":1115}}}],"position":{"start":{"line":24,"column":26,"offset":1109},"end":{"line":24,"column":32,"offset":1115}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":32,"offset":1115},"end":{"line":24,"column":34,"offset":1117}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"right","position":{"start":{"line":24,"column":34,"offset":1117},"end":{"line":24,"column":41,"offset":1124}}}],"position":{"start":{"line":24,"column":34,"offset":1117},"end":{"line":24,"column":41,"offset":1124}}},{"type":"text","value":".","position":{"start":{"line":24,"column":41,"offset":1124},"end":{"line":24,"column":42,"offset":1125}}}],"position":{"start":{"line":21,"column":1,"offset":855},"end":{"line":24,"column":42,"offset":1125}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":24,"column":42,"offset":1125}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":25,"column":1,"offset":1126}}}'})]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when an input event is sent to the WebContents. See\n",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/input-event",title:"InputEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"InputEvent Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}}],"position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":10,"column":9,"offset":117},"end":{"line":10,"column":26,"offset":134}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"undefined","position":{"start":{"line":10,"column":26,"offset":134},"end":{"line":10,"column":37,"offset":145}}}],"position":{"start":{"line":10,"column":26,"offset":134},"end":{"line":10,"column":37,"offset":145}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":37,"offset":145},"end":{"line":10,"column":39,"offset":147}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseDown","position":{"start":{"line":10,"column":39,"offset":147},"end":{"line":10,"column":50,"offset":158}}}],"position":{"start":{"line":10,"column":39,"offset":147},"end":{"line":10,"column":50,"offset":158}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":50,"offset":158},"end":{"line":10,"column":52,"offset":160}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseUp","position":{"start":{"line":10,"column":52,"offset":160},"end":{"line":10,"column":61,"offset":169}}}],"position":{"start":{"line":10,"column":52,"offset":160},"end":{"line":10,"column":61,"offset":169}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":61,"offset":169},"end":{"line":10,"column":63,"offset":171}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseMove","position":{"start":{"line":10,"column":63,"offset":171},"end":{"line":10,"column":74,"offset":182}}}],"position":{"start":{"line":10,"column":63,"offset":171},"end":{"line":10,"column":74,"offset":182}}},{"type":"text","value":",\\n","position":{"start":{"line":10,"column":74,"offset":182},"end":{"line":11,"column":1,"offset":184}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseEnter","position":{"start":{"line":11,"column":3,"offset":186},"end":{"line":11,"column":15,"offset":198}}}],"position":{"start":{"line":11,"column":3,"offset":186},"end":{"line":11,"column":15,"offset":198}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":15,"offset":198},"end":{"line":11,"column":17,"offset":200}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseLeave","position":{"start":{"line":11,"column":17,"offset":200},"end":{"line":11,"column":29,"offset":212}}}],"position":{"start":{"line":11,"column":17,"offset":200},"end":{"line":11,"column":29,"offset":212}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":29,"offset":212},"end":{"line":11,"column":31,"offset":214}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contextMenu","position":{"start":{"line":11,"column":31,"offset":214},"end":{"line":11,"column":44,"offset":227}}}],"position":{"start":{"line":11,"column":31,"offset":214},"end":{"line":11,"column":44,"offset":227}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":44,"offset":227},"end":{"line":11,"column":46,"offset":229}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseWheel","position":{"start":{"line":11,"column":46,"offset":229},"end":{"line":11,"column":58,"offset":241}}}],"position":{"start":{"line":11,"column":46,"offset":229},"end":{"line":11,"column":58,"offset":241}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":58,"offset":241},"end":{"line":11,"column":60,"offset":243}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rawKeyDown","position":{"start":{"line":11,"column":60,"offset":243},"end":{"line":11,"column":72,"offset":255}}}],"position":{"start":{"line":11,"column":60,"offset":243},"end":{"line":11,"column":72,"offset":255}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":72,"offset":255},"end":{"line":12,"column":1,"offset":257}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyDown","position":{"start":{"line":12,"column":3,"offset":259},"end":{"line":12,"column":12,"offset":268}}}],"position":{"start":{"line":12,"column":3,"offset":259},"end":{"line":12,"column":12,"offset":268}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":12,"offset":268},"end":{"line":12,"column":14,"offset":270}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyUp","position":{"start":{"line":12,"column":14,"offset":270},"end":{"line":12,"column":21,"offset":277}}}],"position":{"start":{"line":12,"column":14,"offset":270},"end":{"line":12,"column":21,"offset":277}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":21,"offset":277},"end":{"line":12,"column":23,"offset":279}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"char","position":{"start":{"line":12,"column":23,"offset":279},"end":{"line":12,"column":29,"offset":285}}}],"position":{"start":{"line":12,"column":23,"offset":279},"end":{"line":12,"column":29,"offset":285}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":29,"offset":285},"end":{"line":12,"column":31,"offset":287}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollBegin","position":{"start":{"line":12,"column":31,"offset":287},"end":{"line":12,"column":51,"offset":307}}}],"position":{"start":{"line":12,"column":31,"offset":287},"end":{"line":12,"column":51,"offset":307}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":51,"offset":307},"end":{"line":12,"column":53,"offset":309}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollEnd","position":{"start":{"line":12,"column":53,"offset":309},"end":{"line":12,"column":71,"offset":327}}}],"position":{"start":{"line":12,"column":53,"offset":309},"end":{"line":12,"column":71,"offset":327}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":71,"offset":327},"end":{"line":13,"column":1,"offset":329}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollUpdate","position":{"start":{"line":13,"column":3,"offset":33

11},"end":{"line":13,"column":24,"offset":352}}}],"position":{"start":{"line":13,"column":3,"offset":331},"end":{"line":13,"column":24,"offset":352}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":24,"offset":352},"end":{"line":13,"column":26,"offset":354}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureFlingStart","position":{"start":{"line":13,"column":26,"offset":354},"end":{"line":13,"column":45,"offset":373}}}],"position":{"start":{"line":13,"column":26,"offset":354},"end":{"line":13,"column":45,"offset":373}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":45,"offset":373},"end":{"line":13,"column":47,"offset":375}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureFlingCancel","position":{"start":{"line":13,"column":47,"offset":375},"end":{"line":13,"column":67,"offset":395}}}],"position":{"start":{"line":13,"column":47,"offset":375},"end":{"line":13,"column":67,"offset":395}}},{"type":"text","value":",\\n","position":{"start":{"line":13,"column":67,"offset":395},"end":{"line":14,"column":1,"offset":397}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchBegin","position":{"start":{"line":14,"column":3,"offset":399},"end":{"line":14,"column":22,"offset":418}}}],"position":{"start":{"line":14,"column":3,"offset":399},"end":{"line":14,"column":22,"offset":418}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":22,"offset":418},"end":{"line":14,"column":24,"offset":420}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchEnd","position":{"start":{"line":14,"column":24,"offset":420},"end":{"line":14,"column":41,"offset":437}}}],"position":{"start":{"line":14,"column":24,"offset":420},"end":{"line":14,"column":41,"offset":437}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":41,"offset":437},"end":{"line":14,"column":43,"offset":439}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchUpdate","position":{"start":{"line":14,"column":43,"offset":439},"end":{"line":14,"column":63,"offset":459}}}],"position":{"start":{"line":14,"column":43,"offset":439},"end":{"line":14,"column":63,"offset":459}}},{"type":"text","value":",\\n","position":{"start":{"line":14,"column":63,"offset":459},"end":{"line":15,"column":1,"offset":461}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapDown","position":{"start":{"line":15,"column":3,"offset":463},"end":{"line":15,"column":19,"offset":479}}}],"position":{"start":{"line":15,"column":3,"offset":463},"end":{"line":15,"column":19,"offset":479}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":19,"offset":479},"end":{"line":15,"column":21,"offset":481}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureShowPress","position":{"start":{"line":15,"column":21,"offset":481},"end":{"line":15,"column":39,"offset":499}}}],"position":{"start":{"line":15,"column":21,"offset":481},"end":{"line":15,"column":39,"offset":499}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":39,"offset":499},"end":{"line":15,"column":41,"offset":501}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTap","position":{"start":{"line":15,"column":41,"offset":501},"end":{"line":15,"column":53,"offset":513}}}],"position":{"start":{"line":15,"column":41,"offset":501},"end":{"line":15,"column":53,"offset":513}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":53,"offset":513},"end":{"line":15,"column":55,"offset":515}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapCancel","position":{"start":{"line":15,"column":55,"offset":515},"end":{"line":15,"column":73,"offset":533}}}],"position":{"start":{"line":15,"column":55,"offset":515},"end":{"line":15,"column":73,"offset":533}}},{"type":"text","value":",\\n","position":{"start":{"line":15,"column":73,"offset":533},"end":{"line":16,"column":1,"offset":535}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureShortPress","position":{"start":{"line":16,"column":3,"offset":537},"end":{"line":16,"column":22,"offset":556}}}],"position":{"start":{"line":16,"column":3,"offset":537},"end":{"line":16,"column":22,"offset":556}}},{"type":"text","value":", ","position":{"start":{"line":16,"column":22,"offset":556},"end":{"line":16,"column":24,"offset":558}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureLongPress","position":{"start":{"line":16,"column":24,"offset":558},"end":{"line":16,"column":42,"offset":576}}}],"position":{"start":{"line":16,"column":24,"offset":558},"end":{"line":16,"column":42,"offset":576}}},{"type":"text","value":", ","position":{"start":{"line":16,"column":42,"offset":576},"end":{"line":16,"column":44,"offset":578}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureLongTap","position":{"start":{"line":16,"column":44,"offset":578},"end":{"line":16,"column":60,"offset":594}}}],"position":{"start":{"line":16,"column":44,"offset":578},"end":{"line":16,"column":60,"offset":594}}},{"type":"text","value":",\\n","position":{"start":{"line":16,"column":60,"offset":594},"end":{"line":17,"column":1,"offset":596}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTwoFingerTap","position":{"start":{"line":17,"column":3,"offset":598},"end":{"line":17,"column":24,"offset":619}}}],"position":{"start":{"line":17,"column":3,"offset":598},"end":{"line":17,"column":24,"offset":619}}},{"type":"text","value":", ","position":{"start":{"line":17,"column":24,"offset":619},"end":{"line":17,"column":26,"offset":621}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapUnconfirmed","position":{"start":{"line":17,"column":26,"offset":621},"end":{"line":17,"column":49,"offset":644}}}],"position":{"start":{"line":17,"column":26,"offset":621},"end":{"line":17,"column":49,"offset":644}}},{"type":"text","value":", ","position":{"start":{"line":17,"column":49,"offset":644},"end":{"line":17,"column":51,"offset":646}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureDoubleTap","position":{"start":{"line":17,"column":51,"offset":646},"end":{"line":17,"column":69,"offset":664}}}],"position":{"start":{"line":17,"column":51,"offset":646},"end":{"line":17,"column":69,"offset":664}}},{"type":"text","value":",\\n","position":{"start":{"line":17,"column":69,"offset":664},"end":{"line":18,"column":1,"offset":666}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchStart","position":{"start":{"line":18,"column":3,"offset":668},"end":{"line":18,"column":15,"offset":680}}}],"position":{"start":{"line":18,"column":3,"offset":668},"end":{"line":18,"column":15,"offset":680}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":15,"offset":680},"end":{"line":18,"column":17,"offset":682}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchMove","position":{"start":{"line":18,"column":17,"offset":682},"end":{"line":18,"column":28,"offset":693}}}],"position":{"start":{"line":18,"column":17,"offset":682},"end":{"line":18,"column":28,"offset":693}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":28,"offset":693},"end":{"line":18,"column":30,"offset":695}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchEnd","position":{"start":{"line":18,"column":30,"offset":695},"end":{"line":18,"column":40,"offset":705}}}],"position":{"start":{"line":18,"column":30,"offset":695},"end":{"line":18,"column":40,"offset":705}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":40,"offset":705},"end":{"line":18,"column":42,"offset":707}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchCancel","position":{"start":{"line":18,"column":42,"offset":707},"end":{"line":18,"column":55,"offset":720}}}],"position":{"start":{"line":18,"column":42,"offset":707},"end":{"line":18,"column":55,"offset":720}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":55,"offset":720},"end":{"line":18,"column":57,"offset":722}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchScrollStarted","position":{"start":{"line":18,"column":57,"offset":722},"end":{"line":18,"column":77,"offset":742}}}],"position":{"start":{"line":18,"column":57,"offset":722},"end":{"line":18,"column":77,"offset":742}}},{"type":"text","value":",\\n","position":{"start":{"line":18,"column":77,"offset":742},"end":{"line":19,"column":1,"offset":744}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerDown","position":{"start":{"line":19,"column":3,"offset":746},"end":{"line":19,"column":16,"offset":759}}}],"position":{"start":{"line":19,"column":3,"offset":746},"end":{"line":19,"column":16,"offset":759}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":16,"offset":759},"end":{"line":19,"column":18,"offset":761}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerUp","position":{"start":{"line":19,"column":18,"offset":761},"end":{"line":19,"column":29,"offset":772}}}],"position":{"start":{"line":19,"column":18,"offset":761},"end":{"line":19,"column":29,"offset":772}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":29,"offset":772},"end":{"line":19,"column":31,"offset":774}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerMove","position":{"start":{"line":19,"column":31,"offset":774},"end":{"line":19,"column":44,"offset":787}}}],"position":{"start":{"line":19,"column":31,"offset":774},"end":{"line":19,"column":44,"offset":787}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":44,"offset":787},"end":{"line":19,"column":46,"offset":789}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerRawUpdate","position":{"start":{"line":19,"column":46,"offset":789},"end":{"line":19,"column":64,"offset":807}}}],"position":{"start":{"line":19,"column":46,"offset":789},"end":{"line":19,"column":64,"offset":807}}},{"type":"text","value":",\\n","position":{"start":{"line":19,"column":64,"offset":807},"end":{"line":20,"column":1,"offset":809}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerCancel","position":{"start":{"line":20,"column":3,"offset":811},"end":{"line":20,"column":18,"offset":826}}}],"position":{"start":{"line":20,"column":3,"offset":811},"end":{"line":20,"column":18,"offset":826}}},{"type":"text","value":" or ","position":{"start":{"line":20,"column":18,"offset":826},"end":{"line":20,"column":22,"offset":830}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerCausedUaAction","position":{"start":{"line":20,"column":22,"offset":830},"end":{"line":20,"column":45,"offset":853}}}],"position":{"start":{"line":20,"column":22,"offset":830},"end":{"line":20,"column":45,"offset":853}}},{"type":"text","value":".","position":{"start":{"line":20,"column":45,"offset":853},"end":{"line":20,"column":46,"offset":854}}}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":20,"column":46,"offset":854}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"modifiers","position":{"start":{"line":21,"column":3,"offset":857},"end":{"line":21,"column":14,"offset":868}}}],"position":{"start":{"line":21,"column":3,"offset":857},"end":{"line":21,"column":14,"offset":868}}},{"type":"text","value":" string[] (optional) - An array of modifiers of the event, can\\nbe ","position":{"start":{"line":21,"column":14,"offset":868},"end":{"line":22,"column":6,"offset":936}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"shift","position":{"start":{"line":22,"column":6,"offset":936},"end":{"line":22,"column":13,"offset":943}}}],"position":{"start":{"line":22,"column":6,"offset":936},"end":{"line":22,"column":13,"offset":943}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":13,"offset":943},"end":{"line":22,"column":15,"offset":945}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"control","position":{"start":{"line":22,"column":15,"offset":945},"end":{"line":22,"column":24,"offset":954}}}],"position":{"start":{"line":22,"column":15,"offset":945},"end":{"line":22,"column":24,"offset":954}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":24,"offset":954},"end":{"line":22,"column":26,"offset":956}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ctrl","position":{"start":{"line":22,"column":26,"offset":956},"end":{"line":22,"column":32,"offset":962}}}],"position":{"start":{"line":22,"column":26,"offset":956},"end":{"line":22,"column":32,"offset":962}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":32,"offset":962},"end":{"line":22,"column":34,"offset":964}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"alt","position":{"start":{"line":22,"column":34,"offset":964},"end":{"line":22,"column":39,"offset":969}}}],"position":{"start":{"line":22,"column":34,"offset":964},"end":{"line":22,"column":39,"offset":969}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":39,"offset":969},"end":{"line":22,"column":41,"offset":971}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"meta","position":{"start":{"line":22,"column":41,"offset":971},"end":{"line":22,"column":47,"offset":977}}}],"position":{"start":{"line":22,"column":41,"offset":971},"end":{"line":22,"column":47,"offset":977}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":47,"offset":977},"end":{"line":22,"column":49,"offset":979}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"command","position":{"start":{"line":22,"column":49,"offset":979},"end":{"line":22,"column":58,"offset":988}}}],"position":{"start":{"line":22,"column":49,"offset":979},"end":{"line":22,"column":58,"offset":988}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":58,"offset":988},"end":{"line":22,"column":60,"offset":990}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"cmd","position":{"start":{"line":22,"column":60,"offset":990},"end":{"line":22,"column":65,"offset":995}}}],"position":{"start":{"line":22,"column":60,"offset":990},"end":{"line":22,"column":65,"offset":995}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":65,"offset":995},"end":{"line":22,"column":67,"offset":997}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"iskeypad","position":{"start":{"line":22,"column":67,"offset":997},"end":{"line":22,"column":77,"offset":1007}}}],"position":{"start":{"line":22,"column":67,"offset":997},"end":{"line":22,"column":77,"offset":1007}}},{"type":"text","value":",\\n","position":{"start":{"line":22,"column":77,"offset":1007},"end":{"line":23,"column":1,"offset":1009}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"isautorepeat","position":{"start":{"line":23,"column":3,"offset":1011},"end":{"line":23,"column":17,"offset":1025}}}],"position":{"start":{"line":23,"column":3,"offset":1011},"end":{"line":23,"column":17,"offset":1025}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":17,"offset":1025},"end":{"line":23,"column":19,"offset":1027}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"leftbuttondown","position":{"start":{"line":23,"colum

1n":19,"offset":1027},"end":{"line":23,"column":35,"offset":1043}}}],"position":{"start":{"line":23,"column":19,"offset":1027},"end":{"line":23,"column":35,"offset":1043}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":35,"offset":1043},"end":{"line":23,"column":37,"offset":1045}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"middlebuttondown","position":{"start":{"line":23,"column":37,"offset":1045},"end":{"line":23,"column":55,"offset":1063}}}],"position":{"start":{"line":23,"column":37,"offset":1045},"end":{"line":23,"column":55,"offset":1063}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":55,"offset":1063},"end":{"line":23,"column":57,"offset":1065}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rightbuttondown","position":{"start":{"line":23,"column":57,"offset":1065},"end":{"line":23,"column":74,"offset":1082}}}],"position":{"start":{"line":23,"column":57,"offset":1065},"end":{"line":23,"column":74,"offset":1082}}},{"type":"text","value":",\\n","position":{"start":{"line":23,"column":74,"offset":1082},"end":{"line":24,"column":1,"offset":1084}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"capslock","position":{"start":{"line":24,"column":3,"offset":1086},"end":{"line":24,"column":13,"offset":1096}}}],"position":{"start":{"line":24,"column":3,"offset":1086},"end":{"line":24,"column":13,"offset":1096}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":13,"offset":1096},"end":{"line":24,"column":15,"offset":1098}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"numlock","position":{"start":{"line":24,"column":15,"offset":1098},"end":{"line":24,"column":24,"offset":1107}}}],"position":{"start":{"line":24,"column":15,"offset":1098},"end":{"line":24,"column":24,"offset":1107}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":24,"offset":1107},"end":{"line":24,"column":26,"offset":1109}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"left","position":{"start":{"line":24,"column":26,"offset":1109},"end":{"line":24,"column":32,"offset":1115}}}],"position":{"start":{"line":24,"column":26,"offset":1109},"end":{"line":24,"column":32,"offset":1115}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":32,"offset":1115},"end":{"line":24,"column":34,"offset":1117}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"right","position":{"start":{"line":24,"column":34,"offset":1117},"end":{"line":24,"column":41,"offset":1124}}}],"position":{"start":{"line":24,"column":34,"offset":1117},"end":{"line":24,"column":41,"offset":1124}}},{"type":"text","value":".","position":{"start":{"line":24,"column":41,"offset":1124},"end":{"line":24,"column":42,"offset":1125}}}],"position":{"start":{"line":21,"column":1,"offset":855},"end":{"line":24,"column":42,"offset":1125}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":24,"column":42,"offset":1125}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":25,"column":1,"offset":1126}}}'})," for details."]}),"\n",(0,i.jsx)(t.h4,{id:"event-before-input-event",children:"Event: 'before-input-event'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"input"})," Object - Input properties.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"type"})," string - Either ",(0,i.jsx)(t.code,{children:"keyUp"})," or ",(0,i.jsx)(t.code,{children:"keyDown"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"key"})," string - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.key"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"code"})," string - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.code"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isAutoRepeat"})," boolean - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.repeat"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isComposing"})," boolean - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.isComposing"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"shift"})," boolean - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.shiftKey"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"control"})," boolean - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.controlKey"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"alt"})," boolean - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.altKey"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"meta"})," boolean - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.metaKey"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"location"})," number - Equivalent to ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent",children:"KeyboardEvent.location"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"modifiers"})," string[] - See ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/input-event",title:"InputEvent.modifiers",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"InputEvent Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}}],"position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":10,"column":9,"offset":117},"end":{"line":10,"column":26,"offset":134}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"undefined","position":{"start":{"line":10,"column":26,"offset":134},"end":{"line":10,"column":37,"offset":145}}}],"position":{"start":{"line":10,"column":26,"offset":134},"end":{"line":10,"column":37,"offset":145}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":37,"offset":145},"end":{"line":10,"column":39,"offset":147}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseDown","position":{"start":{"line":10,"column":39,"offset":147},"end":{"line":10,"column":50,"offset":158}}}],"position":{"start":{"line":10,"column":39,"offset":147},"end":{"line":10,"column":50,"offset":158}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":50,"offset":158},"end":{"line":10,"column":52,"offset":160}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseUp","position":{"start":{"line":10,"column":52,"offset":160},"end":{"line":10,"column":61,"offset":169}}}],"position":{"start":{"line":10,"column":52,"offset":160},"end":{"line":10,"column":61,"offset":169}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":61,"offset":169},"end":{"line":10,"column":63,"offset":171}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseMove","position":{"start":{"line":10,"column":63,"offset":171},"end":{"line":10,"column":74,"offset":182}}}],"position":{"start":{"line":10,"column":63,"offset":171},"end":{"line":10,"column":74,"offset":182}}},{"type":"text","value":",\\n","position":{"start":{"line":10,"column":74,"offset":182},"end":{"line":11,"column":1,"offset":184}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseEnter","position":{"start":{"line":11,"column":3,"offset":186},"end":{"line":11,"column":15,"offset":198}}}],"position":{"start":{"line":11,"column":3,"offset":186},"end":{"line":11,"column":15,"offset":198}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":15,"offset":198},"end":{"line":11,"column":17,"offset":200}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseLeave","position":{"start":{"line":11,"column":17,"offset":200},"end":{"line":11,"column":29,"offset":212}}}],"position":{"start":{"line":11,"column":17,"offset":200},"end":{"line":11,"column":29,"offset":212}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":29,"offset":212},"end":{"line":11,"column":31,"offset":214}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contextMenu","position":{"start":{"line":11,"column":31,"offset":214},"end":{"line":11,"column":44,"offset":227}}}],"position":{"start":{"line":11,"column":31,"offset":214},"end":{"line":11,"column":44,"offset":227}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":44,"offset":227},"end":{"line":11,"column":46,"offset":229}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseWheel","position":{"start":{"line":11,"column":46,"offset":229},"end":{"line":11,"column":58,"offset":241}}}],"position":{"start":{"line":11,"column":46,"offset":229},"end":{"line":11,"column":58,"offset":241}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":58,"offset":241},"end":{"line":11,"column":60,"offset":243}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rawKeyDown","position":{"start":{"line":11,"column":60,"offset":243},"end":{"line":11,"column":72,"offset":255}}}],"position":{"start":{"line":11,"column":60,"offset":243},"end":{"line":11,"column":72,"offset":255}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":72,"offset":255},"end":{"line":12,"column":1,"offset":257}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyDown","position":{"start":{"line":12,"column":3,"offset":259},"end":{"line":12,"column":12,"offset":268}}}],"position":{"start":{"line":12,"column":3,"offset":259},"end":{"line":12,"column":12,"offset":268}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":12,"offset":268},"end":{"line":12,"column":14,"offset":270}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyUp","position":{"start":{"line":12,"column":14,"offset":270},"end":{"line":12,"column":21,"offset":277}}}],"position":{"start":{"line":12,"column":14,"offset":270},"end":{"line":12,"column":21,"offset":277}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":21,"offset":277},"end":{"line":12,"column":23,"offset":279}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"char","position":{"start":{"line":12,"column":23,"offset":279},"end":{"line":12,"column":29,"offset":285}}}],"position":{"start":{"line":12,"column":23,"offset":279},"end":{"line":12,"column":29,"offset":285}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":29,"offset":285},"end":{"line":12,"column":31,"offset":287}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollBegin","position":{"start":{"line":12,"column":31,"offset":287},"end":{"line":12,"column":51,"offset":307}}}],"position":{"start":{"line":12,"column":31,"offset":287},"end":{"line":12,"column":51,"offset":307}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":51,"offset":307},"end":{"line":12,"column":53,"offset":309}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollEnd","position":{"start":{"line":12,"column":53,"offset":309},"end":{"line":12,"column":71,"offset":327}}}],"position":{"start":{"line":12,"column":53,"offset":309},"end":{"line":12,"column":71,"offset":327}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":71,"offset":327},"end":{"line":13,"column":1,"offset":329}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureScrollUpdate","position":{"start":{"line":13,"column":3,"offset":33

11},"end":{"line":13,"column":24,"offset":352}}}],"position":{"start":{"line":13,"column":3,"offset":331},"end":{"line":13,"column":24,"offset":352}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":24,"offset":352},"end":{"line":13,"column":26,"offset":354}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureFlingStart","position":{"start":{"line":13,"column":26,"offset":354},"end":{"line":13,"column":45,"offset":373}}}],"position":{"start":{"line":13,"column":26,"offset":354},"end":{"line":13,"column":45,"offset":373}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":45,"offset":373},"end":{"line":13,"column":47,"offset":375}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureFlingCancel","position":{"start":{"line":13,"column":47,"offset":375},"end":{"line":13,"column":67,"offset":395}}}],"position":{"start":{"line":13,"column":47,"offset":375},"end":{"line":13,"column":67,"offset":395}}},{"type":"text","value":",\\n","position":{"start":{"line":13,"column":67,"offset":395},"end":{"line":14,"column":1,"offset":397}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchBegin","position":{"start":{"line":14,"column":3,"offset":399},"end":{"line":14,"column":22,"offset":418}}}],"position":{"start":{"line":14,"column":3,"offset":399},"end":{"line":14,"column":22,"offset":418}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":22,"offset":418},"end":{"line":14,"column":24,"offset":420}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchEnd","position":{"start":{"line":14,"column":24,"offset":420},"end":{"line":14,"column":41,"offset":437}}}],"position":{"start":{"line":14,"column":24,"offset":420},"end":{"line":14,"column":41,"offset":437}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":41,"offset":437},"end":{"line":14,"column":43,"offset":439}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gesturePinchUpdate","position":{"start":{"line":14,"column":43,"offset":439},"end":{"line":14,"column":63,"offset":459}}}],"position":{"start":{"line":14,"column":43,"offset":439},"end":{"line":14,"column":63,"offset":459}}},{"type":"text","value":",\\n","position":{"start":{"line":14,"column":63,"offset":459},"end":{"line":15,"column":1,"offset":461}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapDown","position":{"start":{"line":15,"column":3,"offset":463},"end":{"line":15,"column":19,"offset":479}}}],"position":{"start":{"line":15,"column":3,"offset":463},"end":{"line":15,"column":19,"offset":479}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":19,"offset":479},"end":{"line":15,"column":21,"offset":481}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureShowPress","position":{"start":{"line":15,"column":21,"offset":481},"end":{"line":15,"column":39,"offset":499}}}],"position":{"start":{"line":15,"column":21,"offset":481},"end":{"line":15,"column":39,"offset":499}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":39,"offset":499},"end":{"line":15,"column":41,"offset":501}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTap","position":{"start":{"line":15,"column":41,"offset":501},"end":{"line":15,"column":53,"offset":513}}}],"position":{"start":{"line":15,"column":41,"offset":501},"end":{"line":15,"column":53,"offset":513}}},{"type":"text","value":", ","position":{"start":{"line":15,"column":53,"offset":513},"end":{"line":15,"column":55,"offset":515}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapCancel","position":{"start":{"line":15,"column":55,"offset":515},"end":{"line":15,"column":73,"offset":533}}}],"position":{"start":{"line":15,"column":55,"offset":515},"end":{"line":15,"column":73,"offset":533}}},{"type":"text","value":",\\n","position":{"start":{"line":15,"column":73,"offset":533},"end":{"line":16,"column":1,"offset":535}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureShortPress","position":{"start":{"line":16,"column":3,"offset":537},"end":{"line":16,"column":22,"offset":556}}}],"position":{"start":{"line":16,"column":3,"offset":537},"end":{"line":16,"column":22,"offset":556}}},{"type":"text","value":", ","position":{"start":{"line":16,"column":22,"offset":556},"end":{"line":16,"column":24,"offset":558}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureLongPress","position":{"start":{"line":16,"column":24,"offset":558},"end":{"line":16,"column":42,"offset":576}}}],"position":{"start":{"line":16,"column":24,"offset":558},"end":{"line":16,"column":42,"offset":576}}},{"type":"text","value":", ","position":{"start":{"line":16,"column":42,"offset":576},"end":{"line":16,"column":44,"offset":578}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureLongTap","position":{"start":{"line":16,"column":44,"offset":578},"end":{"line":16,"column":60,"offset":594}}}],"position":{"start":{"line":16,"column":44,"offset":578},"end":{"line":16,"column":60,"offset":594}}},{"type":"text","value":",\\n","position":{"start":{"line":16,"column":60,"offset":594},"end":{"line":17,"column":1,"offset":596}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTwoFingerTap","position":{"start":{"line":17,"column":3,"offset":598},"end":{"line":17,"column":24,"offset":619}}}],"position":{"start":{"line":17,"column":3,"offset":598},"end":{"line":17,"column":24,"offset":619}}},{"type":"text","value":", ","position":{"start":{"line":17,"column":24,"offset":619},"end":{"line":17,"column":26,"offset":621}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureTapUnconfirmed","position":{"start":{"line":17,"column":26,"offset":621},"end":{"line":17,"column":49,"offset":644}}}],"position":{"start":{"line":17,"column":26,"offset":621},"end":{"line":17,"column":49,"offset":644}}},{"type":"text","value":", ","position":{"start":{"line":17,"column":49,"offset":644},"end":{"line":17,"column":51,"offset":646}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gestureDoubleTap","position":{"start":{"line":17,"column":51,"offset":646},"end":{"line":17,"column":69,"offset":664}}}],"position":{"start":{"line":17,"column":51,"offset":646},"end":{"line":17,"column":69,"offset":664}}},{"type":"text","value":",\\n","position":{"start":{"line":17,"column":69,"offset":664},"end":{"line":18,"column":1,"offset":666}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchStart","position":{"start":{"line":18,"column":3,"offset":668},"end":{"line":18,"column":15,"offset":680}}}],"position":{"start":{"line":18,"column":3,"offset":668},"end":{"line":18,"column":15,"offset":680}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":15,"offset":680},"end":{"line":18,"column":17,"offset":682}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchMove","position":{"start":{"line":18,"column":17,"offset":682},"end":{"line":18,"column":28,"offset":693}}}],"position":{"start":{"line":18,"column":17,"offset":682},"end":{"line":18,"column":28,"offset":693}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":28,"offset":693},"end":{"line":18,"column":30,"offset":695}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchEnd","position":{"start":{"line":18,"column":30,"offset":695},"end":{"line":18,"column":40,"offset":705}}}],"position":{"start":{"line":18,"column":30,"offset":695},"end":{"line":18,"column":40,"offset":705}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":40,"offset":705},"end":{"line":18,"column":42,"offset":707}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchCancel","position":{"start":{"line":18,"column":42,"offset":707},"end":{"line":18,"column":55,"offset":720}}}],"position":{"start":{"line":18,"column":42,"offset":707},"end":{"line":18,"column":55,"offset":720}}},{"type":"text","value":", ","position":{"start":{"line":18,"column":55,"offset":720},"end":{"line":18,"column":57,"offset":722}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"touchScrollStarted","position":{"start":{"line":18,"column":57,"offset":722},"end":{"line":18,"column":77,"offset":742}}}],"position":{"start":{"line":18,"column":57,"offset":722},"end":{"line":18,"column":77,"offset":742}}},{"type":"text","value":",\\n","position":{"start":{"line":18,"column":77,"offset":742},"end":{"line":19,"column":1,"offset":744}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerDown","position":{"start":{"line":19,"column":3,"offset":746},"end":{"line":19,"column":16,"offset":759}}}],"position":{"start":{"line":19,"column":3,"offset":746},"end":{"line":19,"column":16,"offset":759}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":16,"offset":759},"end":{"line":19,"column":18,"offset":761}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerUp","position":{"start":{"line":19,"column":18,"offset":761},"end":{"line":19,"column":29,"offset":772}}}],"position":{"start":{"line":19,"column":18,"offset":761},"end":{"line":19,"column":29,"offset":772}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":29,"offset":772},"end":{"line":19,"column":31,"offset":774}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerMove","position":{"start":{"line":19,"column":31,"offset":774},"end":{"line":19,"column":44,"offset":787}}}],"position":{"start":{"line":19,"column":31,"offset":774},"end":{"line":19,"column":44,"offset":787}}},{"type":"text","value":", ","position":{"start":{"line":19,"column":44,"offset":787},"end":{"line":19,"column":46,"offset":789}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerRawUpdate","position":{"start":{"line":19,"column":46,"offset":789},"end":{"line":19,"column":64,"offset":807}}}],"position":{"start":{"line":19,"column":46,"offset":789},"end":{"line":19,"column":64,"offset":807}}},{"type":"text","value":",\\n","position":{"start":{"line":19,"column":64,"offset":807},"end":{"line":20,"column":1,"offset":809}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerCancel","position":{"start":{"line":20,"column":3,"offset":811},"end":{"line":20,"column":18,"offset":826}}}],"position":{"start":{"line":20,"column":3,"offset":811},"end":{"line":20,"column":18,"offset":826}}},{"type":"text","value":" or ","position":{"start":{"line":20,"column":18,"offset":826},"end":{"line":20,"column":22,"offset":830}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pointerCausedUaAction","position":{"start":{"line":20,"column":22,"offset":830},"end":{"line":20,"column":45,"offset":853}}}],"position":{"start":{"line":20,"column":22,"offset":830},"end":{"line":20,"column":45,"offset":853}}},{"type":"text","value":".","position":{"start":{"line":20,"column":45,"offset":853},"end":{"line":20,"column":46,"offset":854}}}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":20,"column":46,"offset":854}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"modifiers","position":{"start":{"line":21,"column":3,"offset":857},"end":{"line":21,"column":14,"offset":868}}}],"position":{"start":{"line":21,"column":3,"offset":857},"end":{"line":21,"column":14,"offset":868}}},{"type":"text","value":" string[] (optional) - An array of modifiers of the event, can\\nbe ","position":{"start":{"line":21,"column":14,"offset":868},"end":{"line":22,"column":6,"offset":936}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"shift","position":{"start":{"line":22,"column":6,"offset":936},"end":{"line":22,"column":13,"offset":943}}}],"position":{"start":{"line":22,"column":6,"offset":936},"end":{"line":22,"column":13,"offset":943}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":13,"offset":943},"end":{"line":22,"column":15,"offset":945}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"control","position":{"start":{"line":22,"column":15,"offset":945},"end":{"line":22,"column":24,"offset":954}}}],"position":{"start":{"line":22,"column":15,"offset":945},"end":{"line":22,"column":24,"offset":954}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":24,"offset":954},"end":{"line":22,"column":26,"offset":956}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ctrl","position":{"start":{"line":22,"column":26,"offset":956},"end":{"line":22,"column":32,"offset":962}}}],"position":{"start":{"line":22,"column":26,"offset":956},"end":{"line":22,"column":32,"offset":962}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":32,"offset":962},"end":{"line":22,"column":34,"offset":964}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"alt","position":{"start":{"line":22,"column":34,"offset":964},"end":{"line":22,"column":39,"offset":969}}}],"position":{"start":{"line":22,"column":34,"offset":964},"end":{"line":22,"column":39,"offset":969}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":39,"offset":969},"end":{"line":22,"column":41,"offset":971}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"meta","position":{"start":{"line":22,"column":41,"offset":971},"end":{"line":22,"column":47,"offset":977}}}],"position":{"start":{"line":22,"column":41,"offset":971},"end":{"line":22,"column":47,"offset":977}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":47,"offset":977},"end":{"line":22,"column":49,"offset":979}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"command","position":{"start":{"line":22,"column":49,"offset":979},"end":{"line":22,"column":58,"offset":988}}}],"position":{"start":{"line":22,"column":49,"offset":979},"end":{"line":22,"column":58,"offset":988}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":58,"offset":988},"end":{"line":22,"column":60,"offset":990}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"cmd","position":{"start":{"line":22,"column":60,"offset":990},"end":{"line":22,"column":65,"offset":995}}}],"position":{"start":{"line":22,"column":60,"offset":990},"end":{"line":22,"column":65,"offset":995}}},{"type":"text","value":", ","position":{"start":{"line":22,"column":65,"offset":995},"end":{"line":22,"column":67,"offset":997}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"iskeypad","position":{"start":{"line":22,"column":67,"offset":997},"end":{"line":22,"column":77,"offset":1007}}}],"position":{"start":{"line":22,"column":67,"offset":997},"end":{"line":22,"column":77,"offset":1007}}},{"type":"text","value":",\\n","position":{"start":{"line":22,"column":77,"offset":1007},"end":{"line":23,"column":1,"offset":1009}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"isautorepeat","position":{"start":{"line":23,"column":3,"offset":1011},"end":{"line":23,"column":17,"offset":1025}}}],"position":{"start":{"line":23,"column":3,"offset":1011},"end":{"line":23,"column":17,"offset":1025}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":17,"offset":1025},"end":{"line":23,"column":19,"offset":1027}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"leftbuttondown","position":{"start":{"line":23,"colum

1n":19,"offset":1027},"end":{"line":23,"column":35,"offset":1043}}}],"position":{"start":{"line":23,"column":19,"offset":1027},"end":{"line":23,"column":35,"offset":1043}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":35,"offset":1043},"end":{"line":23,"column":37,"offset":1045}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"middlebuttondown","position":{"start":{"line":23,"column":37,"offset":1045},"end":{"line":23,"column":55,"offset":1063}}}],"position":{"start":{"line":23,"column":37,"offset":1045},"end":{"line":23,"column":55,"offset":1063}}},{"type":"text","value":", ","position":{"start":{"line":23,"column":55,"offset":1063},"end":{"line":23,"column":57,"offset":1065}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rightbuttondown","position":{"start":{"line":23,"column":57,"offset":1065},"end":{"line":23,"column":74,"offset":1082}}}],"position":{"start":{"line":23,"column":57,"offset":1065},"end":{"line":23,"column":74,"offset":1082}}},{"type":"text","value":",\\n","position":{"start":{"line":23,"column":74,"offset":1082},"end":{"line":24,"column":1,"offset":1084}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"capslock","position":{"start":{"line":24,"column":3,"offset":1086},"end":{"line":24,"column":13,"offset":1096}}}],"position":{"start":{"line":24,"column":3,"offset":1086},"end":{"line":24,"column":13,"offset":1096}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":13,"offset":1096},"end":{"line":24,"column":15,"offset":1098}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"numlock","position":{"start":{"line":24,"column":15,"offset":1098},"end":{"line":24,"column":24,"offset":1107}}}],"position":{"start":{"line":24,"column":15,"offset":1098},"end":{"line":24,"column":24,"offset":1107}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":24,"offset":1107},"end":{"line":24,"column":26,"offset":1109}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"left","position":{"start":{"line":24,"column":26,"offset":1109},"end":{"line":24,"column":32,"offset":1115}}}],"position":{"start":{"line":24,"column":26,"offset":1109},"end":{"line":24,"column":32,"offset":1115}}},{"type":"text","value":", ","position":{"start":{"line":24,"column":32,"offset":1115},"end":{"line":24,"column":34,"offset":1117}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"right","position":{"start":{"line":24,"column":34,"offset":1117},"end":{"line":24,"column":41,"offset":1124}}}],"position":{"start":{"line":24,"column":34,"offset":1117},"end":{"line":24,"column":41,"offset":1124}}},{"type":"text","value":".","position":{"start":{"line":24,"column":41,"offset":1124},"end":{"line":24,"column":42,"offset":1125}}}],"position":{"start":{"line":21,"column":1,"offset":855},"end":{"line":24,"column":42,"offset":1125}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":24,"column":42,"offset":1125}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":25,"column":1,"offset":1126}}}'}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted before dispatching the ",(0,i.jsx)(t.code,{children:"keydown"})," and ",(0,i.jsx)(t.code,{children:"keyup"})," events in the page.\nCalling ",(0,i.jsx)(t.code,{children:"event.preventDefault"})," will prevent the page ",(0,i.jsx)(t.code,{children:"keydown"}),"/",(0,i.jsx)(t.code,{children:"keyup"})," events\nand the menu shortcuts."]}),"\n",(0,i.jsxs)(t.p,{children:["To only prevent the menu shortcuts, use\n",(0,i.jsx)(t.a,{href:"#contentssetignoremenushortcutsignore",children:(0,i.jsx)(t.code,{children:"setIgnoreMenuShortcuts"})}),":"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { app, BrowserWindow } = require('electron')\n\napp.whenReady().then(() => {\n  const win = new BrowserWindow({ width: 800, height: 600 })\n\n  win.webContents.on('before-input-event', (event, input) => {\n    // Enable application menu keyboard shortcuts when Ctrl/Cmd are down.\n    win.webContents.setIgnoreMenuShortcuts(!input.control && !input.meta)\n  })\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"event-before-mouse-event",children:"Event: 'before-mouse-event'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"mouse"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/mouse-input-event",title:"MouseInputEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"MouseInputEvent Object extends InputEvent"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":169},"end":{"line":10,"column":9,"offset":175}}}],"position":{"start":{"line":10,"column":3,"offset":169},"end":{"line":10,"column":9,"offset":175}}},{"type":"text","value":" string - The type of the event, can be ","position":{"start":{"line":10,"column":9,"offset":175},"end":{"line":10,"column":49,"offset":215}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseDown","position":{"start":{"line":10,"column":49,"offset":215},"end":{"line":10,"column":60,"offset":226}}}],"position":{"start":{"line":10,"column":49,"offset":215},"end":{"line":10,"column":60,"offset":226}}},{"type":"text","value":",\\n","position":{"start":{"line":10,"column":60,"offset":226},"end":{"line":11,"column":1,"offset":228}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseUp","position":{"start":{"line":11,"column":5,"offset":232},"end":{"line":11,"column":14,"offset":241}}}],"position":{"start":{"line":11,"column":5,"offset":232},"end":{"line":11,"column":14,"offset":241}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":14,"offset":241},"end":{"line":11,"column":16,"offset":243}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseEnter","position":{"start":{"line":11,"column":16,"offset":243},"end":{"line":11,"column":28,"offset":255}}}],"position":{"start":{"line":11,"column":16,"offset":243},"end":{"line":11,"column":28,"offset":255}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":28,"offset":255},"end":{"line":11,"column":30,"offset":257}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseLeave","position":{"start":{"line":11,"column":30,"offset":257},"end":{"line":11,"column":42,"offset":269}}}],"position":{"start":{"line":11,"column":30,"offset":257},"end":{"line":11,"column":42,"offset":269}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":42,"offset":269},"end":{"line":11,"column":44,"offset":271}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contextMenu","position":{"start":{"line":11,"column":44,"offset":271},"end":{"line":11,"column":57,"offset":284}}}],"position":{"start":{"line":11,"column":44,"offset":271},"end":{"line":11,"column":57,"offset":284}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":57,"offset":284},"end":{"line":11,"column":59,"offset":286}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseWheel","position":{"start":{"line":11,"column":59,"offset":286},"end":{"line":11,"column":71,"offset":298}}}],"position":{"start":{"line":11,"column":59,"offset":286},"end":{"line":11,"column":71,"offset":298}}},{"type":"text","value":" or ","position":{"start":{"line":11,"column":71,"offset":298},"end":{"line":11,"column":75,"offset":302}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseMove","position":{"start":{"line":11,"column":75,"offset":302},"end":{"line":11,"column":86,"offset":313}}}],"position":{"start":{"line":11,"column":75,"offset":302},"end":{"line":11,"column":86,"offset":313}}},{"type":"text","value":".","position":{"start":{"line":11,"column":86,"offset":313},"end":{"line":11,"column":87,"offset":314}}}],"position":{"start":{"line":10,"column":1,"offset":167},"end":{"line":11,"column":87,"offset":314}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":12,"column":3,"offset":317},"end":{"line":12,"column":6,"offset":320}}}],"position":{"start":{"line":12,"column":3,"offset":317},"end":{"line":12,"column":6,"offset":320}}},{"type":"text","value":" Integer","position":{"start":{"line":12,"column":6,"offset":320},"end":{"line":12,"column":14,"offset":328}}}],"position":{"start":{"line":12,"column":1,"offset":315},"end":{"line":12,"column":14,"offset":328}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":13,"column":3,"offset":33

11},"end":{"line":13,"column":6,"offset":334}}}],"position":{"start":{"line":13,"column":3,"offset":331},"end":{"line":13,"column":6,"offset":334}}},{"type":"text","value":" Integer","position":{"start":{"line":13,"column":6,"offset":334},"end":{"line":13,"column":14,"offset":342}}}],"position":{"start":{"line":13,"column":1,"offset":329},"end":{"line":13,"column":14,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"button","position":{"start":{"line":14,"column":3,"offset":345},"end":{"line":14,"column":11,"offset":353}}}],"position":{"start":{"line":14,"column":3,"offset":345},"end":{"line":14,"column":11,"offset":353}}},{"type":"text","value":" string (optional) - The button pressed, can be ","position":{"start":{"line":14,"column":11,"offset":353},"end":{"line":14,"column":59,"offset":401}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"left","position":{"start":{"line":14,"column":59,"offset":401},"end":{"line":14,"column":65,"offset":407}}}],"position":{"start":{"line":14,"column":59,"offset":401},"end":{"line":14,"column":65,"offset":407}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":65,"offset":407},"end":{"line":14,"column":67,"offset":409}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"middle","position":{"start":{"line":14,"column":67,"offset":409},"end":{"line":14,"column":75,"offset":417}}}],"position":{"start":{"line":14,"column":67,"offset":409},"end":{"line":14,"column":75,"offset":417}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":75,"offset":417},"end":{"line":14,"column":77,"offset":419}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"right","position":{"start":{"line":14,"column":77,"offset":419},"end":{"line":14,"column":84,"offset":426}}}],"position":{"start":{"line":14,"column":77,"offset":419},"end":{"line":14,"column":84,"offset":426}}},{"type":"text","value":".","position":{"start":{"line":14,"column":84,"offset":426},"end":{"line":14,"column":85,"offset":427}}}],"position":{"start":{"line":14,"column":1,"offset":343},"end":{"line":14,"column":85,"offset":427}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"globalX","position":{"start":{"line":15,"column":3,"offset":430},"end":{"line":15,"column":12,"offset":439}}}],"position":{"start":{"line":15,"column":3,"offset":430},"end":{"line":15,"column":12,"offset":439}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":15,"column":12,"offset":439},"end":{"line":15,"column":31,"offset":458}}}],"position":{"start":{"line":15,"column":1,"offset":428},"end":{"line":15,"column":31,"offset":458}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"globalY","position":{"start":{"line":16,"column":3,"offset":461},"end":{"line":16,"column":12,"offset":470}}}],"position":{"start":{"line":16,"column":3,"offset":461},"end":{"line":16,"column":12,"offset":470}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":16,"column":12,"offset":470},"end":{"line":16,"column":31,"offset":489}}}],"position":{"start":{"line":16,"column":1,"offset":459},"end":{"line":16,"column":31,"offset":489}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"movementX","position":{"start":{"line":17,"column":3,"offset":492},"end":{"line":17,"column":14,"offset":503}}}],"position":{"start":{"line":17,"column":3,"offset":492},"end":{"line":17,"column":14,"offset":503}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":17,"column":14,"offset":503},"end":{"line":17,"column":33,"offset":522}}}],"position":{"start":{"line":17,"column":1,"offset":490},"end":{"line":17,"column":33,"offset":522}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"movementY","position":{"start":{"line":18,"column":3,"offset":525},"end":{"line":18,"column":14,"offset":536}}}],"position":{"start":{"line":18,"column":3,"offset":525},"end":{"line":18,"column":14,"offset":536}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":18,"column":14,"offset":536},"end":{"line":18,"column":33,"offset":555}}}],"position":{"start":{"line":18,"column":1,"offset":523},"end":{"line":18,"column":33,"offset":555}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"clickCount","position":{"start":{"line":19,"column":3,"offset":558},"end":{"line":19,"column":15,"offset":570}}}],"position":{"start":{"line":19,"column":3,"offset":558},"end":{"line":19,"column":15,"offset":570}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":19,"column":15,"offset":570},"end":{"line":19,"column":34,"offset":589}}}],"position":{"start":{"line":19,"column":1,"offset":556},"end":{"line":19,"column":34,"offset":589}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":167},"end":{"line":19,"column":34,"offset":589}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":590}}}'})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted before dispatching mouse events in the page."}),"\n",(0,i.jsxs)(t.p,{children:["Calling ",(0,i.jsx)(t.code,{children:"event.preventDefault"})," will prevent the page mouse events."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { app, BrowserWindow } = require('electron')\n\napp.whenReady().then(() =>

1 {\n  const win = new BrowserWindow({ width: 800, height: 600 })\n\n  win.webContents.on('before-mouse-event', (event, mouse) => {\n    // Prevent mouseDown events.\n    if (mouse.type === 'mouseDown') {\n      console.log(mouse)\n      /*\n      {\n        type: 'mouseDown',\n        clickCount: 1,\n        movementX: 0,\n        movementY: 0,\n        button: 'left',\n        x: 632.359375,\n        y: 480.6875,\n        globalX: 168.359375,\n        globalY: 193.6875\n      }\n      */\n      event.preventDefault()\n    }\n  })\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"event-enter-html-full-screen",children:"Event: 'enter-html-full-screen'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the window enters a full-screen state triggered by HTML API."}),"\n",(0,i.jsx)(t.h4,{id:"event-leave-html-full-screen",children:"Event: 'leave-html-full-screen'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the window leaves a full-screen state triggered by HTML API."}),"\n",(0,i.jsx)(t.h4,{id:"event-zoom-changed",children:"Event: 'zoom-changed'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"zoomDirection"})," string - Can be ",(0,i.jsx)(t.code,{children:"in"})," or ",(0,i.jsx)(t.code,{children:"out"}),"."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the user is requesting to change the zoom level using the mouse wheel."}),"\n",(0,i.jsx)(t.h4,{id:"event-blur",children:"Event: 'blur'"}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the ",(0,i.jsx)(t.code,{children:"WebContents"})," loses focus."]}),"\n",(0,i.jsx)(t.h4,{id:"event-focus",children:"Event: 'focus'"}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the ",(0,i.jsx)(t.code,{children:"WebContents"})," gains focus."]}),"\n",(0,i.jsxs)(t.p,{children:["Note that on macOS, having focus means the ",(0,i.jsx)(t.code,{children:"WebContents"})," is the first responder\nof window, so switching focus between windows would not trigger the ",(0,i.jsx)(t.code,{children:"focus"})," and\n",(0,i.jsx)(t.code,{children:"blur"})," events of ",(0,i.jsx)(t.code,{children:"WebContents"}),", as the first responder of each window is not\nchanged."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"focus"})," and ",(0,i.jsx)(t.code,{children:"blur"})," events of ",(0,i.jsx)(t.code,{children:"WebContents"})," should only be used to detect\nfocus change between different ",(0,i.jsx)(t.code,{children:"WebContents"})," and ",(0,i.jsx)(t.code,{children:"BrowserView"})," in the same\nwindow."]}),"\n",(0,i.jsx)(t.h4,{id:"event-devtools-open-url",children:"Event: 'devtools-open-url'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - URL of the link that was clicked or selected."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a link is clicked in DevTools or 'Open in new tab' is selected for a link in its context menu."}),"\n",(0,i.jsx)(t.h4,{id:"event-devtools-search-query",children:"Event: 'devtools-search-query'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"query"})," string - text to query for."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when 'Search' is selected for text in its context menu."}),"\n",(0,i.jsx)(t.h4,{id:"event-devtools-opened",children:"Event: 'devtools-opened'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when DevTools is opened."}),"\n",(0,i.jsx)(t.h4,{id:"event-devtools-closed",children:"Event: 'devtools-closed'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when DevTools is closed."}),"\n",(0,i.jsx)(t.h4,{id:"event-devtools-focused",children:"Event: 'devtools-focused'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when DevTools is focused / opened."}),"\n",(0,i.jsx)(t.h4,{id:"event-certificate-error",children:"Event: 'certificate-error'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"error"})," string - The error code."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"certificate"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/certificate",title:"Certificate",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Certificate Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"data","position":{"start":{"line":10,"column":3,"offset":113},"end":{"line":10,"column":9,"offset":119}}}],"position":{"start":{"line":10,"column":3,"offset":113},"end":{"line":10,"column":9,"offset":119}}},{"type":"text","value":" string - PEM encoded data","position":{"start":{"line":10,"column":9,"offset":119},"end":{"line":10,"column":35,"offset":145}}}],"position":{"start":{"line":10,"column":1,"offset":111},"end":{"line":10,"column":35,"offset":145}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuer","position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":11,"offset":156}}}],"position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":11,"offset":156}}},{"type":"text","value":" ","position":{"start":{"line":11,"column":11,"offset":156},"end":{"line":11,"column":12,"offset":157}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/certificate-principal"},"children":[{"type":"text","value":"CertificatePrincipal"}]},{"type":"text","value":" - Issuer principal","position":{"start":{"line":11,"column":60,"offset":205},"end":{"line":11,"column":79,"offset":224}}}],"position":{"start":{"line":11,"column":1,"offset":146},"end":{"line":11,"column":79,"offset":224}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuerName","position":{"start":{"line":12,"column":3,"offset":227},"end":{"line":12,"column":15,"offset":239}}}],"position":{"start":{"line":12,"column":3,"offset":227},"end":{"line":12,"column":15,"offset":239}}},{"type":"text","value":" string - Issuer\'s Common Name","position":{"start":{"line":12,"column":15,"offset":239},"end":{"line":12,"column":45,"offset":269}}}],"position":{"start":{"line":12,"column":1,"offset":225},"end":{"line":12,"column":45,"offset":269}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuerCert","position":{"start":{"line":13,"column":3,"offset":272},"end":{"line":13,"column":15,"offset":284}}}],"position":{"start":{"line":13,"column":3,"offset":272},"end":{"line":13,"column":15,"offset":284}}},{"type":"text","value":" Certificate - Issuer certificate (if not self-signed)","position":{"start":{"line":13,"column":15,"offset":284},"end":{"line":13,"column":69,"offset":338}}}],"position":{"start":{"line":13,"column":1,"offset":270},"end":{"line":13,"column":69,"offset":338}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subject","position":{"start":{"line":14,"column":3,"offset":341},"end":{"line":14,"column":12,"offset":350}}}],"position":{"start":{"line":14,"column":3,"offset":341},"end":{"line":14,"column":12,"offset":350}}},{"type":"text","value":" ","position":{"start":{"line":14,"column":12,"offset":350},"end":{"line":14,"column":13,"offset":351}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/certificate-principal"},"children":[{"type":"text","value":"CertificatePrincipal"}]},{"type":"text","value":" - Subject principal","position":{"start":{"line":14,"column":61,"offset":399},"end":{"line":14,"column":81,"offset":419}}}],"position":{"start":{"line":14,"column":1,"offset":339},"end":{"line":14,"column":81,"offset":419}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subjectName","position":{"start":{"line":15,"column":3,"offset":422},"end":{"line":15,"column":16,"offset":435}}}],"position":{"start":{"line":15,"column":3,"offset":422},"end":{"line":15,"column":16,"offset":435}}},{"type":"text","value":" string - Subject\'s Common Name","position":{"start":{"line":15,"column":16,"offset":435},"end":{"line":15,"column":47,"offset":466}}}],"position":{"start":{"line":15,"column":1,"offset":420},"end":{"line":15,"column":47,"offset":466}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"serialNumber","position":{"start":{"line":16,"column":3,"offset":469},"end":{"line":16,"column":17,"offset":483}}}],"position":{"start":{"line":16,"column":3,"offset":469},"end":{"line":16,"column":17,"offset":483}}},{"type":"text","value":" string - Hex value represented string","position":{"start":{"line":16,"column":17,"offset":483},"end":{"line":16,"column":55,"offset":521}}}],"position":{"start":{"line":16,"column":1,"offset":467},"end":{"line":16,"column":55,"offset":521}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"validStart","position":{"start":{"line":17,"column":3,"offset":524},"end":{"line":17,"column":15,"offset":536}}}],"position":{"start":{"line":17,"column":3,"offset":524},"end":{"line":17,"column":15,"offset":536}}},{"type":"text","value":" number - Start date of the certificate being valid in seconds","position":{"start":{"line":17,"column":15,"offset":536},"end":{"line":17,"column":77,"offset":598}}}],"position":{"start":{"line":17,"column":1,"offset":522},"end":{"line":17,"column":77,"offset":598}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"validExpiry","position":{"start":{"line":18,"column":3,"offset":601},"end":{"line":18,"column":16,"offset":614}}}],"position":{"start":{"line":18,"column":3,"offset":601},"end":{"line":18,"column":16,"offset":614}}},{"type":"text","value":" number - End date of the certificate being valid in seconds","position":{"start":{"line":18,"column":16,"offset":614},"end":{"line":18,"column":76,"offset":674}}}],"position":{"start":{"line":18,"column":1,"offset":599},"end":{"line":18,"column":76,"offset":674}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"fingerprint","position":{"start":{"line":19,"column":3,"offset":677},"end":{"line":19,"column":16,"offset":690}}}],"position":{"start":{"line":19,"column":3,"offset":677},"end":{"line":19,"column":16,"offset":690}}},{"type":"text","value":" string - Fingerprint of the certificate","position":{"start":{"line":19,"column":16,"offset":690},"end":{"line":19,"column":56,"offset":730}}}],"position":{"start":{"line":19,"column":1,"offset":675},"end":{"line":19,"column":56,"offset":730}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":111},"end":{"line":19,"column":56,"offset":730}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":731}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"callback"})," Function","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isTrusted"})," boolean - Indicates whether the certificate can be considered trusted."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMainFrame"})," boolean"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when failed to verify the ",(0,i.jsx)(t.code,{children:"certificate"})," for ",(0,i.jsx)(t.code,{children:"url"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["The usage is the same with ",(0,i.jsxs)(t.a,{href:"/docs/latest/api/app#event-certificate-error",children:["the ",(0,i.jsx)(t.code,{children:"certificate-error"})," event of ",(0,i.jsx)(t.code,{children:"app"})]}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-select-client-certificate",children:"Event: 'select-client-certificate'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," URL"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"certificateList"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/certificate",title:"Certificate[]",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Certificate Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"data","position":{"start":{"line":10,"column":3,"offset":113},"end":{"line":10,"column":9,"offset":119}}}],"position":{"start":{"line":10,"column":3,"offset":113},"end":{"line":10,"column":9,"offset":119}}},{"type":"text","value":" string - PEM encoded data","position":{"start":{"line":10,"column":9,"offset":119},"end":{"line":10,"column":35,"offset":145}}}],"position":{"start":{"line":10,"column":1,"offset":111},"end":{"line":10,"column":35,"offset":145}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuer","position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":11,"offset":156}}}],"position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":11,"offset":156}}},{"type":"text","value":" ","position":{"start":{"line":11,"column":11,"offset":156},"end":{"line":11,"column":12,"offset":157}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/certificate-principal"},"children":[{"type":"text","value":"CertificatePrincipal"}]},{"type":"text","value":" - Issuer principal","position":{"start":{"line":11,"column":60,"offset":205},"end":{"line":11,"column":79,"offset":224}}}],"position":{"start":{"line":11,"column":1,"offset":146},"end":{"line":11,"column":79,"offset":224}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuerName","position":{"start":{"line":12,"column":3,"offset":227},"end":{"line":12,"column":15,"offset":239}}}],"position":{"start":{"line":12,"column":3,"offset":227},"end":{"line":12,"column":15,"offset":239}}},{"type":"text","value":" string - Issuer\'s Common Name","position":{"start":{"line":12,"column":15,"offset":239},"end":{"line":12,"column":45,"offset":269}}}],"position":{"start":{"line":12,"column":1,"offset":225},"end":{"line":12,"column":45,"offset":269}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuerCert","position":{"start":{"line":13,"column":3,"offset":272},"end":{"line":13,"column":15,"offset":28

14}}}],"position":{"start":{"line":13,"column":3,"offset":272},"end":{"line":13,"column":15,"offset":284}}},{"type":"text","value":" Certificate - Issuer certificate (if not self-signed)","position":{"start":{"line":13,"column":15,"offset":284},"end":{"line":13,"column":69,"offset":338}}}],"position":{"start":{"line":13,"column":1,"offset":270},"end":{"line":13,"column":69,"offset":338}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subject","position":{"start":{"line":14,"column":3,"offset":341},"end":{"line":14,"column":12,"offset":350}}}],"position":{"start":{"line":14,"column":3,"offset":341},"end":{"line":14,"column":12,"offset":350}}},{"type":"text","value":" ","position":{"start":{"line":14,"column":12,"offset":350},"end":{"line":14,"column":13,"offset":351}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/certificate-principal"},"children":[{"type":"text","value":"CertificatePrincipal"}]},{"type":"text","value":" - Subject principal","position":{"start":{"line":14,"column":61,"offset":399},"end":{"line":14,"column":81,"offset":419}}}],"position":{"start":{"line":14,"column":1,"offset":339},"end":{"line":14,"column":81,"offset":419}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subjectName","position":{"start":{"line":15,"column":3,"offset":422},"end":{"line":15,"column":16,"offset":435}}}],"position":{"start":{"line":15,"column":3,"offset":422},"end":{"line":15,"column":16,"offset":435}}},{"type":"text","value":" string - Subject\'s Common Name","position":{"start":{"line":15,"column":16,"offset":435},"end":{"line":15,"column":47,"offset":466}}}],"position":{"start":{"line":15,"column":1,"offset":420},"end":{"line":15,"column":47,"offset":466}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"serialNumber","position":{"start":{"line":16,"column":3,"offset":469},"end":{"line":16,"column":17,"offset":483}}}],"position":{"start":{"line":16,"column":3,"offset":469},"end":{"line":16,"column":17,"offset":483}}},{"type":"text","value":" string - Hex value represented string","position":{"start":{"line":16,"column":17,"offset":483},"end":{"line":16,"column":55,"offset":521}}}],"position":{"start":{"line":16,"column":1,"offset":467},"end":{"line":16,"column":55,"offset":521}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"validStart","position":{"start":{"line":17,"column":3,"offset":524},"end":{"line":17,"column":15,"offset":536}}}],"position":{"start":{"line":17,"column":3,"offset":524},"end":{"line":17,"column":15,"offset":536}}},{"type":"text","value":" number - Start date of the certificate being valid in seconds","position":{"start":{"line":17,"column":15,"offset":536},"end":{"line":17,"column":77,"offset":598}}}],"position":{"start":{"line":17,"column":1,"offset":522},"end":{"line":17,"column":77,"offset":598}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"validExpiry","position":{"start":{"line":18,"column":3,"offset":601},"end":{"line":18,"column":16,"offset":614}}}],"position":{"start":{"line":18,"column":3,"offset":601},"end":{"line":18,"column":16,"offset":614}}},{"type":"text","value":" number - End date of the certificate being valid in seconds","position":{"start":{"line":18,"column":16,"offset":614},"end":{"line":18,"column":76,"offset":674}}}],"position":{"start":{"line":18,"column":1,"offset":599},"end":{"line":18,"column":76,"offset":674}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"fingerprint","position":{"start":{"line":19,"column":3,"offset":677},"end":{"line":19,"column":16,"offset":690}}}],"position":{"start":{"line":19,"column":3,"offset":677},"end":{"line":19,"column":16,"offset":690}}},{"type":"text","value":" string - Fingerprint of the certificate","position":{"start":{"line":19,"column":16,"offset":690},"end":{"line":19,"column":56,"offset":730}}}],"position":{"start":{"line":19,"column":1,"offset":675},"end":{"line":19,"column":56,"offset":730}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":111},"end":{"line":19,"column":56,"offset":730}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":731}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"callback"})," Function","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"certificate"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/certificate",title:"Certificate",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Certificate Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"data","position":{"start":{"line":10,"column":3,"offset":113},"end":{"line":10,"column":9,"offset":119}}}],"position":{"start":{"line":10,"column":3,"offset":113},"end":{"line":10,"column":9,"offset":119}}},{"type":"text","value":" string - PEM encoded data","position":{"start":{"line":10,"column":9,"offset":119},"end":{"line":10,"column":35,"offset":145}}}],"position":{"start":{"line":10,"column":1,"offset":111},"end":{"line":10,"column":35,"offset":145}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuer","position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":11,"offset":156}}}],"position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":11,"offset":156}}},{"type":"text","value":" ","position":{"start":{"line":11,"column":11,"offset":156},"end":{"line":11,"column":12,"offset":157}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/certificate-principal"},"children":[{"type":"text","value":"CertificatePrincipal"}]},{"type":"text","value":" - Issuer principal","position":{"start":{"line":11,"column":60,"offset":205},"end":{"line":11,"column":79,"offset":224}}}],"position":{"start":{"line":11,"column":1,"offset":146},"end":{"line":11,"column":79,"offset":224}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuerName","position":{"start":{"line":12,"column":3,"offset":227},"end":{"line":12,"column":15,"offset":239}}}],"position":{"start":{"line":12,"column":3,"offset":227},"end":{"line":12,"column":15,"offset":239}}},{"type":"text","value":" string - Issuer\'s Common Name","position":{"start":{"line":12,"column":15,"offset":239},"end":{"line":12,"column":45,"offset":269}}}],"position":{"start":{"line":12,"column":1,"offset":225},"end":{"line":12,"column":45,"offset":269}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"issuerCert","position":{"start":{"line":13,"column":3,"offset":272},"end":{"line":13,"column":15,"offset":284}}}],"position":{"start":{"line":13,"column":3,"offset":272},"end":{"line":13,"column":15,"offset":284}}},{"type":"text","value":" Certificate - Issuer certificate (if not self-signed)","position":{"start":{"line":13,"column":15,"offset":284},"end":{"line":13,"column":69,"offset":338}}}],"position":{"start":{"line":13,"column":1,"offset":270},"end":{"line":13,"column":69,"offset":338}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subject","position":{"start":{"line":14,"column":3,"offset":341},"end":{"line":14,"column":12,"offset":350}}}],"position":{"start":{"line":14,"column":3,"offset":341},"end":{"line":14,"column":12,"offset":350}}},{"type":"text","value":" ","position":{"start":{"line":14,"column":12,"offset":350},"end":{"line":14,"column":13,"offset":351}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/certificate-principal"},"children":[{"type":"text","value":"CertificatePrincipal"}]},{"type":"text","value":" - Subject principal","position":{"start":{"line":14,"column":61,"offset":399},"end":{"line":14,"column":81,"offset":419}}}],"position":{"start":{"line":14,"column":1,"offset":339},"end":{"line":14,"column":81,"offset":419}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subjectName","position":{"start":{"line":15,"column":3,"offset":422},"end":{"line":15,"column":16,"offset":435}}}],"position":{"start":{"line":15,"column":3,"offset":422},"end":{"line":15,"column":16,"offset":435}}},{"type":"text","value":" string - Subject\'s Common Name","position":{"start":{"line":15,"column":16,"offset":435},"end":{"line":15,"column":47,"offset":466}}}],"position":{"start":{"line":15,"column":1,"offset":420},"end":{"line":15,"column":47,"offset":466}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"serialNumber","position":{"start":{"line":16,"column":3,"offset":469},"end":{"line":16,"column":17,"offset":483}}}],"position":{"start":{"line":16,"column":3,"offset":469},"end":{"line":16,"column":17,"offset":483}}},{"type":"text","value":" string - Hex value represented string","position":{"start":{"line":16,"column":17,"offset":483},"end":{"line":16,"column":55,"offset":521}}}],"position":{"start":{"line":16,"column":1,"offset":467},"end":{"line":16,"column":55,"offset":521}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"validStart","position":{"start":{"line":17,"column":3,"offset":524},"end":{"line":17,"column":15,"offset":536}}}],"position":{"start":{"line":17,"column":3,"offset":524},"end":{"line":17,"column":15,"offset":536}}},{"type":"text","value":" number - Start date of the certificate being valid in seconds","position":{"start":{"line":17,"column":15,"offset":536},"end":{"line":17,"column":77,"offset":598}}}],"position":{"start":{"line":17,"column":1,"offset":522},"end":{"line":17,"column":77,"offset":598}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"validExpiry","position":{"start":{"line":18,"column":3,"offset":601},"end":{"line":18,"column":16,"offset":614}}}],"position":{"start":{"line":18,"column":3,"offset":601},"end":{"line":18,"column":16,"offset":614}}},{"type":"text","value":" number - End date of the certificate being valid in seconds","position":{"start":{"line":18,"column":16,"offset":614},"end":{"line":18,"column":76,"offset":674}}}],"position":{"start":{"line":18,"column":1,"offset":599},"end":{"line":18,"column":76,"offset":674}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"fingerprint","position":{"start":{"line":19,"column":3,"offset":677},"end":{"line":19,"column":16,"offset":690}}}],"position":{"start":{"line":19,"column":3,"offset":677},"end":{"line":19,"column":16,"offset":690}}},{"type":"text","value":" string - Fingerprint of the certificate","position":{"start":{"line":19,"column":16,"offset":690},"end":{"line":19,"column":56,"offset":730}}}],"position":{"start":{"line":19,"column":1,"offset":675},"end":{"line":19,"column":56,"offset":730}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":111},"end":{"line":19,"column":56,"offset":730}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":731}}}'})," - Must be a certificate from the given list."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a client certificate is requested."}),"\n",(0,i.jsxs)(t.p,{children:["The usage is the same with ",(0,i.jsxs)(t.a,{href:"/docs/latest/api/app#event-select-client-certificate",children:["the ",(0,i.jsx)(t.code,{children:"select-client-certificate"})," event of ",(0,i.jsx)(t.code,{children:"app"})]}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-login",children:"Event: 'login'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"authenticationResponseDetails"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," URL"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pid"})," number"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isRequestForNavigation"})," boolean - Indicates whether the request is for a navigation."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"firstAuthAttempt"})," boolean - Indicates whether this is the first authentication attempt."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"responseHeaders"})," Record<string, string | string[]> (optional) - The headers returned in the response."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"authInfo"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isProxy"})," boolean"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scheme"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"host"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"port"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"realm"})," string"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"callback"})," Function","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"username"})," string (optional)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"password"})," string (optional)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when ",(0,i.jsx)(t.code,{children:"webContents"})," wants to do basic auth."]}),"\n",(0,i.jsxs)(t.p,{children:["The usage is the same with ",(0,i.jsxs)(t.a,{href:"/docs/latest/api/app#event-login",children:["the ",(0,i.jsx)(t.code,{children:"login"})," event of ",(0,i.jsx)(t.code,{children:"app"})]}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-found-in-page",children:"Event: 'foun

1d-in-page'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"result"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"requestId"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"activeMatchOrdinal"})," Integer - Position of the active match."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"matches"})," Integer - Number of Matches."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"selectionArea"})," Rectangle - Coordinates of first match region."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"finalUpdate"})," boolean"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a result is available for\n",(0,i.jsx)(t.a,{href:"#contentsfindinpagetext-options",children:(0,i.jsx)(t.code,{children:"webContents.findInPage"})})," request."]}),"\n",(0,i.jsx)(t.h4,{id:"event-media-started-playing",children:"Event: 'media-started-playing'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when media starts playing."}),"\n",(0,i.jsx)(t.h4,{id:"event-media-paused",children:"Event: 'media-paused'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when media is paused or done playing."}),"\n",(0,i.jsx)(t.h4,{id:"event-audio-state-changed",children:"Event: 'audio-state-changed'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"audible"})," boolean - True if one or more frames or child ",(0,i.jsx)(t.code,{children:"webContents"})," are emitting audio."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when media becomes audible or inaudible."}

1),"\n",(0,i.jsx)(t.h4,{id:"event-did-change-theme-color",children:"Event: 'did-change-theme-color'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"color"})," (string | null) - Theme color is in format of '#rrggbb'. It is ",(0,i.jsx)(t.code,{children:"null"})," when no theme color is set."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a page's theme color changes. This is usually due to encountering\na meta tag:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-html",children:"<meta name='theme-color' content='#ff0000'>\n"})}),"\n",(0,i.jsx)(t.h4,{id:"event-update-target-url",children:"Event: 'update-target-url'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when mouse moves over a link or the keyboard moves the focus to a link."}),"\n",(0,i.jsx)(t.h4,{id:"event-cursor-changed",children:"Event: 'cursor-changed'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"type"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"image"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:"NativeImage"})," (optional)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scale"})," Float (optional) - scaling factor for the custom cursor."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"size"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/size",title:"Size",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Size Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}}],"position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}},{"type":"text","value":" number","position":{"start":{"line":10,"column":10,"offset":99},"end":{"line":10,"column":17,"offset":106}}}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":10,"column":17,"offset":106}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}}],"position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}},{"type":"text","value":" number","position":{"start":{"line":11,"column":11,"offset":117},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":11,"column":1,"offset":107},"end":{"line":11,"column":18,"offset":124}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":125}}}'})," (optional) - the size of the ",(0,i.jsx)(t.code,{children:"image"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"hotspot"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/point",title:"Point",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Point Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":95},"end":{"line":10,"column":6,"offset":98}}}],"position":{"start":{"line":10,"column":3,"offset":95},"end":{"line":10,"column":6,"offset":98}}},{"type":"text","value":" number","position":{"start":{"line":10,"column":6,"offset":98},"end":{"line":10,"column":13,"offset":105}}}],"position":{"start":{"line":10,"column":1,"offset":93},"end":{"line":10,"column":13,"offset":105}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":108},"end":{"line":11,"column":6,"offset":111}}}],"position":{"start":{"line":11,"column":3,"offset":108},"end":{"line":11,"column":6,"offset":111}}},{"type":"text","value":" number","position":{"start":{"line":11,"column":6,"offset":111},"end":{"line":11,"column":13,"offset":118}}}],"position":{"start":{"line":11,"column":1,"offset":106},"end":{"line":11,"column":13,"offset":118}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":93},"end":{"line":11,"column":13,"offset":118}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Both "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":14,"column":8,"offset":137},"end":{"line":14,"column":11,"offset":140}}}],"position":{"start":{"line":14,"column":8,"offset":137},"end":{"line":14,"column":11,"offset":140}}},{"type":"text","value":" and ","position":{"start":{"line":14,"column":11,"offset":140},"end":{"line":14,"column":16,"offset":145}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":14,"column":16,"offset":145},"end":{"line":14,"column":19,"offset":148}}}],"position":{"start":{"line":14,"column":16,"offset":145},"end":{"line":14,"column":19,"offset":148}}},{"type":"text","value":" must be whole integers, when providing a point object\\nas input to an Electron API we will automatically round your ","position":{"start":{"line":14,"column":19,"offset":148},"end":{"line":15,"column":64,"offset":266}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":15,"column":64,"offset":266},"end":{"line":15,"column":67,"offset":269}}}],"position":{"start":{"line":15,"column":64,"offset":266},"end":{"line":15,"column":67,"offset":269}}},{"type":"text","value":" and ","position":{"start":{"line":15,"column":67,"offset":269},"end":{"line":15,"column":72,"offset":274}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":15,"column":72,"offset":274},"end":{"line":15,"column":75,"offset":277}}}],"position":{"start":{"line":15,"column":72,"offset":274},"end":{"line":15,"column":75,"offset":277}}},{"type":"text","value":" values\\nto the nearest whole integer.","position":{"start":{"line":15,"column":75,"offset":277},"end":{"line":16,"column":32,"offset":316}}}]}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":17,"column":1,"offset":317}}}'}

1)," (optional) - coordinates of the custom cursor's hotspot."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the cursor's type changes. The ",(0,i.jsx)(t.code,{children:"type"})," parameter can be ",(0,i.jsx)(t.code,{children:"pointer"}),",\n",(0,i.jsx)(t.code,{children:"crosshair"}),", ",(0,i.jsx)(t.code,{children:"hand"}),", ",(0,i.jsx)(t.code,{children:"text"}),", ",(0,i.jsx)(t.code,{children:"wait"}),", ",(0,i.jsx)(t.code,{children:"help"}),", ",(0,i.jsx)(t.code,{children:"e-resize"}),", ",(0,i.jsx)(t.code,{children:"n-resize"}),", ",(0,i.jsx)(t.code,{children:"ne-resize"}),",\n",(0,i.jsx)(t.code,{children:"nw-resize"}),", ",(0,i.jsx)(t.code,{children:"s-resize"}),", ",(0,i.jsx)(t.code,{children:"se-resize"}),", ",(0,i.jsx)(t.code,{children:"sw-resize"}),", ",(0,i.jsx)(t.code,{children:"w-resize"}),", ",(0,i.jsx)(t.code,{children:"ns-resize"}),", ",(0,i.jsx)(t.code,{children:"ew-resize"}),",\n",(0,i.jsx)(t.code,{children:"nesw-resize"}),", ",(0,i.jsx)(t.code,{children:"nwse-resize"}),", ",(0,i.jsx)(t.code,{children:"col-resize"}),", ",(0,i.jsx)(t.code,{children:"row-resize"}),", ",(0,i.jsx)(t.code,{children:"m-panning"}),", ",(0,i.jsx)(t.code,{children:"m-panning-vertical"}),",\n",(0,i.jsx)(t.code,{children:"m-panning-horizontal"}),", ",(0,i.jsx)(t.code,{children:"e-panning"}),", ",(0,i.jsx)(t.code,{children:"n-panning"}),", ",(0,i.jsx)(t.code,{children:"ne-panning"}),", ",(0,i.jsx)(t.code,{children:"nw-panning"}),", ",(0,i.jsx)(t.code,{children:"s-panning"}),",\n",(0,i.jsx)(t.code,{children:"se-panning"}),", ",(0,i.jsx)(t.code,{children:"sw-panning"}),", ",(0,i.jsx)(t.code,{children:"w-panning"}),", ",(0,i.jsx)(t.code,{children:"move"}),", ",(0,i.jsx)(t.code,{children:"vertical-text"}),", ",(0,i.jsx)(t.code,{children:"cell"}),", ",(0,i.jsx)(t.code,{children:"context-menu"}),",\n",(0,i.jsx)(t.code,{children:"alias"}),", ",(0,i.jsx)(t.code,{children:"progress"}),", ",(0,i.jsx)(t.code,{children:"nodrop"}),", ",(0,i.jsx)(t.code,{children:"copy"}),", ",(0,i.jsx)(t.code,{children:"none"}),", ",(0,i.jsx)(t.code,{children:"not-allowed"}),", ",(0,i.jsx)(t.code,{children:"zoom-in"}),", ",(0,i.jsx)(t.code,{children:"zoom-out"}),", ",(0,i.jsx)(t.code,{children:"grab"}),",\n",(0,i.jsx)(t.code,{children:"grabbing"}),", ",(0,i.jsx)(t.code,{children:"custom"}),", ",(0,i.jsx)(t.code,{children:"null"}),", ",(0,i.jsx)(t.code,{children:"drag-drop-none"}),", ",(0,i.jsx)(t.code,{children:"drag-drop-move"}),", ",(0,i.jsx)(t.code,{children:"drag-drop-copy"}),",\n",(0,i.jsx)(t.code,{children:"drag-drop-link"}),", ",(0,i.jsx)(t.code,{children:"ns-no-resize"}),", ",(0,i.jsx)(t.code,{children:"ew-no-resize"}),", ",(0,i.jsx)(t.code,{children:"nesw-no-resize"}),", ",(0,i.jsx)(t.code,{children:"nwse-no-resize"}),",\nor ",(0,i.jsx)(t.code,{children:"default"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["If the ",(0,i.jsx)(t.code,{children:"type"})," parameter is ",(0,i.jsx)(t.code,{children:"custom"}),", the ",(0,i.jsx)(t.code,{children:"image"})," parameter will hold the custom\ncursor image in a ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:(0,i.jsx)(t.code,{children:"NativeImage"})}),", and ",(0,i.jsx)(t.code,{children:"scale"}),", ",(0,i.jsx)(t.code,{children:"size"})," and ",(0,i.jsx)(t.code,{children:"hotspot"})," will hold\nadditional information about the custom cursor."]}),"\n",(0,i.jsx)(t.h4,{id:"event-context-menu",children:"Event: 'context-menu'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"params"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"x"})," Integer - x coordinate."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"y"})," Integer - y coordinate."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - Frame from which the context menu was invoked.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"linkURL"})," string - URL of the link that encloses the node the context menu\nwas invoked on."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"linkText"})," string - Text associated with the link. May be an empty\nstring if the contents of the link are an image."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pageURL"})," string - URL of the top level page that the context menu was\ninvoked on."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameURL"})," string - URL of the subframe that the context menu was invoked\non."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"srcURL"})," string - Source URL for the element that the context menu\nwas invoked on. Elements with source URLs are images, audio and video."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"mediaType"})," string - Type of the node the context menu was invoked on. Can\nbe ",(0,i.jsx)(t.code,{children:"none"}),", ",(0,i.jsx)(t.code,{children:"image"}),", ",(0,i.jsx)(t.code,{children:"audio"}),", ",(0,i.jsx)(t.code,{children:"video"}),", ",(0,i.jsx)(t.code,{children:"canvas"}),", ",(0,i.jsx)(t.code,{children:"file"})," or ",(0,i.jsx)(t.code,{children:"plugin"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"hasImageContents"})," boolean - Whether the context menu was invoked on an image\nwhich has non-empty contents."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isEditable"})," boolean - Whether the context is editable."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"selectionText"})," string - Text of the selection that the context menu was\ninvoked on."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"titleText"})," string - Title text of the selection that the context menu was\ninvoked on."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"altText"})," string - Alt text of the selection that the context menu was\ninvoked on."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"suggestedFilename"})," string - Suggested filename to be used when saving file through 'Save\nLink As' option of context menu."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"selectionRect"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/rectangle",title:"Rectangle",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Rectangle Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}}],"position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}},{"type":"text","value":" number - The x coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":10,"column":6,"offset":110},"end":{"line":10,"column":85,"offset":189}}}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":10,"column":85,"offset":189}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}}],"position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}},{"type":"text","value":" number - The y coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":11,"column":6,"offset":195},"end":{"line":11,"column":85,"offset":274}}}],"position":{"start":{"line":11,"column":1,"offset":190},"end":{"line":11,"column":85,"offset":274}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}}],"position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}},{"type":"text","value":" number - The width of the rectangle (must be an integer).","position":{"start":{"line":12,"column":10,"offset":284},"end":{"line":12,"column":68,"offset":342}}}],"position":{"start":{"line":12,"column":1,"offset":275},"end":{"line":12,"column":68,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}}],"position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}},{"type":"text","value":" number - The height of the rectangle (must be an integer).","position":{"start":{"line":13,"column":11,"offset":353},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":13,"column":1,"offset":343},"end":{"line":13,"column":70,"offset":412}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":14,"column":1,"offset":413}}}'})," - Rect representing the coordinates in the document space of the selection."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"selectionStartOffset"})," number - Start position of the selection text."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"referrerPolicy"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/referrer",title:"Referrer",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Referrer Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"url","position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}}],"position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}},{"type":"text","value":" string - HTTP Referrer URL.","position":{"start":{"line":10,"column":8,"offset":109},"end":{"line":10,"column":36,"offset":137}}}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":10,"column":36,"offset":137}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"policy","position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}}],"position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":11,"column":11,"offset":148},"end":{"line":11,"column":28,"offset":165}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"default","position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}}],"position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":37,"offset":174},"end":{"line":11,"column":39,"offset":176}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"unsafe-url","position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}}],"position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":51,"offset":188},"end":{"line":12,"column":1,"offset":190}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer-when-downgrade","position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}}],"position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":31,"offset":220},"end":{"line":12,"column":33,"offset":222}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer","position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}}],"position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":46,"offset":235},"end":{"line":12,"column":48,"offset":237}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"origin","position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}}],"position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":56,"offset":245},"end":{"line":13,"column":1,"offset":247}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin-when-cross-origin","position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}}],"position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":36,"offset":282},"end":{"line":13,"column":38,"offset":284}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"same-origin","position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}}],"position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}},{"type":"text","value":" or ","position":{"start":{"line":13,"column":51,"offset":297},"end":{"line":13,"column":55,"offset":301}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin","position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}}],"position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}},{"type":"text","value":".\\nSee the ","position":{"start":{"line":13,"column":70,"offset":316},"end":{"line":14,"column":11,"offset":328}}},{"type":"element","tagName":"a","properties":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy"},"children":[{"type":"text","value":"Referrer-Policy spec","position":{"start":{"line":14,"column":12,"offset":329},"end":{"line":14,"column":32,"offset":349}}}],"position":{"start":{"line":14,"column":11,"offset":328},"end":{"line":14,"column":36,"offset":353}}},{"type":"text","value":" for more details on the\\nmeaning of these values.","position":{"start":{"line":14,"column":36,"offset":353},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":11,"column":1,"offset":138},"end":{"line":15,"column":27,"offset":404}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":18,"column":1,"offset":485}}}'})," - The referrer policy of the frame on which the menu is invoked."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"misspelledWord"})," string - The misspelled word under the cursor, if any."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"dictionarySuggestions"})," string[] - An array of suggested words to show the\nuser to replace the ",(0,i.jsx)(t.code,{children:"misspelledWord"}),".  Only available if there is

1a misspelled\nword and spellchecker is enabled."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameCharset"})," string - The character encoding of the frame on which the\nmenu was invoked."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"formControlType"})," string - The source that the context menu was invoked on.\nPossible values include ",(0,i.jsx)(t.code,{children:"none"}),", ",(0,i.jsx)(t.code,{children:"button-button"}),", ",(0,i.jsx)(t.code,{children:"field-set"}),",\n",(0,i.jsx)(t.code,{children:"input-button"}),", ",(0,i.jsx)(t.code,{children:"input-checkbox"}),", ",(0,i.jsx)(t.code,{children:"input-color"}),", ",(0,i.jsx)(t.code,{children:"input-date"}),",\n",(0,i.jsx)(t.code,{children:"input-datetime-local"}),", ",(0,i.jsx)(t.code,{children:"input-email"}),", ",(0,i.jsx)(t.code,{children:"input-file"}),", ",(0,i.jsx)(t.code,{children:"input-hidden"}),",\n",(0,i.jsx)(t.code,{children:"input-image"}),", ",(0,i.jsx)(t.code,{children:"input-month"}),", ",(0,i.jsx)(t.code,{children:"input-number"}),", ",(0,i.jsx)(t.code,{children:"input-password"}),", ",(0,i.jsx)(t.code,{children:"input-radio"}),",\n",(0,i.jsx)(t.code,{children:"input-range"}),", ",(0,i.jsx)(t.code,{children:"input-reset"}),", ",(0,i.jsx)(t.code,{children:"input-search"}),", ",(0,i.jsx)(t.code,{children:"input-submit"}),", ",(0,i.jsx)(t.code,{children:"input-telephone"}),",\n",(0,i.jsx)(t.code,{children:"input-text"}),", ",(0,i.jsx)(t.code,{children:"input-time"}),", ",(0,i.jsx)(t.code,{children:"input-url"}),", ",(0,i.jsx)(t.code,{children:"input-week"}),", ",(0,i.jsx)(t.code,{children:"output"}),", ",(0,i.jsx)(t.code,{children:"reset-button"}),",\n",(0,i.jsx)(t.code,{children:"select-list"}),", ",(0,i.jsx)(t.code,{children:"select-list"}),", ",(0,i.jsx)(t.code,{children:"select-multiple"}),", ",(0,i.jsx)(t.code,{children:"select-one"}),", ",(0,i.jsx)(t.code,{children:"submit-button"}),",\nand ",(0,i.jsx)(t.code,{children:"text-area"}),","]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"spellcheckEnabled"})," boolean - If the context is editable, whether or not spellchecking is enabled."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"menuSourceType"})," string - Input source that invoked the context menu.\nCan be ",(0,i.jsx)(t.code,{children:"none"}),", ",(0,i.jsx)(t.code,{children:"mouse"}),", ",(0,i.jsx)(t.code,{children:"keyboard"}),", ",(0,i.jsx)(t.code,{children:"touch"}),", ",(0,i.jsx)(t.code,{children:"touchMenu"}),", ",(0,i.jsx)(t.code,{children:"longPress"}),", ",(0,i.jsx)(t.code,{children:"longTap"}),", ",(0,i.jsx)(t.code,{children:"touchHandle"}),", ",(0,i.jsx)(t.code,{children:"stylus"}),", ",(0,i.jsx)(t.code,{children:"adjustSelection"}),", or ",(0,i.jsx)(t.code,{children:"adjustSelectionReset"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"mediaFlags"})," Object - The flags for the media element the context menu was\ninvoked on.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"inError"})," boolean - Whether the media element has crashed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isPaused"})," boolean - Whether the media element is paused."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isMuted"})," boolean - Whether the media element is muted."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"hasAudio"})," boolean - Whether the media element has audio."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isLooping"})," boolean - Whether the media element is looping."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isControlsVisible"})," boolean - Whether the media element's controls are\nvisible."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canToggleControls"})," boolean - Whether the media element's controls are\ntoggleable."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canPrint"})," boolean - Whether the media element can be printed."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canSave"})," boolean - Whether or not the media element can be downloaded."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canShowPictureInPicture"})," boolean - Whether the media element can show picture-in-picture."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isShowingPictureInPicture"})," boolean - Whether the media element is currently showing picture-in-picture."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canRotate"})," boolean - Whether the media element can be rotated."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canLoop"})," boolean - Whether the media element can be looped."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"editFlags"})," Object - These flags indicate whether the renderer believes it\nis able to perform the corresponding action.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canUndo"})," boolean - Whether the renderer believes it can undo."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canRedo"})," boolean - Whether the renderer believes it can redo."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canCut"})," boolean - Whether the renderer believes it can cut."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canCopy"})," boolean - Whether the renderer believes it can copy."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canPaste"})," boolean - Whether the renderer believes it can paste."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canDelete"})," boolean - Whether the renderer believes it can delete."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canSelectAll"})," boolean - Whether the renderer believes it can select all."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"canEditRichly"})," boolean - Whether the renderer believes it can edit text richly."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when there is a new context menu that needs to be handled."}),"\n",(0,i.jsx)(t.h4,{id:"event-select-bluetooth-device",children:"Event: 'select-bluetooth-device'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"devices"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/bluetooth-device",title:"BluetoothDevice[]",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"BluetoothDevice Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"deviceName","position":{"start":{"line":10,"column":3,"offset":126},"end":{"line":10,"column":15,"offset":138}}}],"position":{"start":{"line":10,"column":3,"offset":126},"end":{"line":10,"column":15,"offset":138}}},{"type":"text","value":" string","position":{"start":{"line":10,"column":15,"offset":138},"end":{"line":10,"column":22,"offset":145}}}],"position":{"start":{"line":10,"column":1,"offset":124},"end":{"line":10,"column":22,"offset":145}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"deviceId","position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":13,"offset":158}}}],"position":{"start":{"line":11,"column":3,"offset":148},"end":{"line":11,"column":13,"offset":158}}},{"type":"text","value":" string","position":{"start":{"line":11,"column":13,"offset":158},"end":{"line":11,"column":20,"offset":165}}}],"position":{"start":{"line":11,"column":1,"offset":146},"end":{"line":11,"column":20,"offset":165}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":124},"end":{"line":11,"column":20,"offset":165}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":166}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"callback"})," Function","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"deviceId"})," string"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a bluetooth device needs to be selected when a call to\n",(0,i.jsx)(t.code,{children:"navigator.bluetooth.requestDevice"})," is made. ",(0,i.jsx)(t.code,{children:"callback"})," should be called with\nthe ",(0,i.jsx)(t.code,{children:"deviceId"})," of the device to be selected.  Passing an empty string to\n",(0,i.jsx)(t.code,{children:"callback"})," will cancel the request."]}),"\n",(0,i.jsx)(t.p,{children:"If no event listener is added for this event, all bluetooth requests will be cancelled."}),"\n",(0,i.jsxs)(t.p,{children:["If ",(0,i.jsx)(t.code,{children:"event.preventDefault"})," is not called when handling this event, the first available\ndevice will be automatically selected."]}),"\n",(0,i.jsxs)(t.p,{children:["Due to the nature of bluetooth, scanning for devices when\n",(0,i.jsx)(t.code,{children:"navigator.bluetooth.requestDevice"})," is called may take time and will cause\n",(0,i.jsx)(t.code,{children:"select-bluetooth-device"})," to fire multiple times until ",(0,i.jsx)(t.code,{children:"callback"})," is called\nwith either a device id or an empty string to cancel the request."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",metastring:"title='main.js'",children:"const { app, BrowserWindow } = require('electron')\n\nlet win = null\n\napp.whenReady().then(() =>

1 {\n  win = new BrowserWindow({ width: 800, height: 600 })\n  win.webContents.on('select-bluetooth-device', (event, deviceList, callback) => {\n    event.preventDefault()\n    const result = deviceList.find((device) => {\n      return device.deviceName === 'test'\n    })\n    if (!result) {\n      // The device wasn't found so we need to either wait longer (eg until the\n      // device is turned on) or cancel the request by calling the callback\n      // with an empty string.\n      callback('')\n    } else {\n      callback(result.deviceId)\n    }\n  })\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"event-paint",children:"Event: 'paint'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"texture"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/offscreen-shared-texture",title:"OffscreenSharedTexture",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"OffscreenSharedTexture Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"textureInfo","position":{"start":{"line":10,"column":3,"offset":148},"end":{"line":10,"column":16,"offset":161}}}],"position":{"start":{"line":10,"column":3,"offset":148},"end":{"line":10,"column":16,"offset":161}}},{"type":"text","value":" Object - The shared texture info.","position":{"start":{"line":10,"column":16,"offset":161},"end":{"line":10,"column":50,"offset":195}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"widgetType","position":{"start":{"line":11,"column":5,"offset":200},"end":{"line":11,"column":17,"offset":212}}}],"position":{"start":{"line":11,"column":5,"offset":200},"end":{"line":11,"column":17,"offset":212}}},{"type":"text","value":" string - The widget type of the texture. Can be ","position":{"start":{"line":11,"column":17,"offset":212},"end":{"line":11,"column":66,"offset":261}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"popup","position":{"start":{"line":11,"column":66,"offset":261},"end":{"line":11,"column":73,"offset":268}}}],"position":{"start":{"line":11,"column":66,"offset":261},"end":{"line":11,"column":73,"offset":268}}},{"type":"text","value":" or ","position":{"start":{"line":11,"column":73,"offset":268},"end":{"line":11,"column":77,"offset":272}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"frame","position":{"start":{"line":11,"column":77,"offset":272},"end":{"line":11,"column":84,"offset":279}}}],"position":{"start":{"line":11,"column":77,"offset":272},"end":{"line":11,"column":84,"offset":279}}},{"type":"text","value":".","position":{"start":{"line":11,"column":84,"offset":279},"end":{"line":11,"column":85,"offset":280}}}],"position":{"start":{"line":11,"column":3,"offset":198},"end":{"line":11,"column":85,"offset":280}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"pixelFormat","position":{"start":{"line":12,"column":5,"offset":285},"end":{"line":12,"column":18,"offset":298}}}],"position":{"start":{"line":12,"column":5,"offset":285},"end":{"line":12,"column":18,"offset":298}}},{"type":"text","value":" string - The pixel format of the texture.","position":{"start":{"line":12,"column":18,"offset":298},"end":{"line":12,"column":60,"offset":340}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rgba","position":{"start":{"line":13,"column":7,"offset":347},"end":{"line":13,"column":13,"offset":353}}}],"position":{"start":{"line":13,"column":7,"offset":347},"end":{"line":13,"column":13,"offset":353}}},{"type":"text","value":" - The texture format is 8-bit unorm RGBA.","position":{"start":{"line":13,"column":13,"offset":353},"end":{"line":13,"column":55,"offset":395}}}],"position":{"start":{"line":13,"column":5,"offset":345},"end":{"line":13,"column":55,"offset":395}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"bgra","position":{"start":{"line":14,"column":7,"offset":402},"end":{"line":14,"column":13,"offset":408}}}],"position":{"start":{"line":14,"column":7,"offset":402},"end":{"line":14,"column":13,"offset":408}}},{"type":"text","value":" - The texture format is 8-bit unorm BGRA.","position":{"start":{"line":14,"column":13,"offset":408},"end":{"line":14,"column":55,"offset":450}}}],"position":{"start":{"line":14,"column":5,"offset":400},"end":{"line":14,"column":55,"offset":450}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rgbaf16","position":{"start":{"line":15,"column":7,"offset":457},"end":{"line":15,"column":16,"offset":466}}}],"position":{"start":{"line":15,"column":7,"offset":457},"end":{"line":15,"column":16,"offset":466}}},{"type":"text","value":" - The texture format is 16-bit float RGBA.","position":{"start":{"line":15,"column":16,"offset":466},"end":{"line":15,"column":59,"offset":509}}}],"position":{"start":{"line":15,"column":5,"offset":455},"end":{"line":15,"column":59,"offset":509}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":13,"column":5,"offset":345},"end":{"line":15,"column":59,"offset":509}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":12,"column":3,"offset":283},"end":{"line":15,"column":59,"offset":509}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"codedSize","position":{"start":{"line":16,"column":5,"offset":514},"end":{"line":16,"column":16,"offset":525}}}],"position":{"start":{"line":16,"column":5,"offset":514},"end":{"line":16,"column":16,"offset":525}}},{"type":"text","value":" ","position":{"start":{"line":16,"column":16,"offset":525},"end":{"line":16,"column":17,"offset":526}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/size"},"children":[{"type":"text","value":"Size"}]},{"type":"text","value":" - The full dimensions of the video frame.","position":{"start":{"line":16,"column":32,"offset":541},"end":{"line":16,"column":74,"offset":583}}}],"position":{"start":{"line":16,"column":3,"offset":512},"end":{"line":16,"column":74,"offset":583}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"colorSpace","position":{"start":{"line":17,"column":5,"offset":588},"end":{"line":17,"column":17,"offset":600}}}],"position":{"start":{"line":17,"column":5,"offset":588},"end":{"line":17,"column":17,"offset":600}}},{"type":"text","value":" ","position":{"start":{"line":17,"column":17,"offset":600},"end":{"line":17,"column":18,"offset":601}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/color-space"},"children":[{"type":"text","value":"ColorSpace"}]},{"type":"text","value":" - The color space of the video frame.","position":{"start":{"line":17,"column":46,"offset":629},"end":{"line":17,"column":84,"offset":667}}}],"position":{"start":{"line":17,"column":3,"offset":586},"end":{"line":17,"column":84,"offset":667}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"visibleRect","position":{"start":{"line":18,"column":5,"offset":672},"end":{"line":18,"column":18,"offset":685}}}],"position":{"start":{"line":18,"column":5,"offset":672},"end":{"line":18,"column":18,"offset":685}}},{"type":"text","value":" ","position":{"start":{"line":18,"column":18,"offset":685},"end":{"line":18,"column":19,"offset":686}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/rectangle"},"children":[{"type":"text","value":"Rectangle"}]}

1,{"type":"text","value":" - A subsection of [0, 0, codedSize.width, codedSize.height]. In OSR case, it is expected to have the full section area.","position":{"start":{"line":18,"column":44,"offset":711},"end":{"line":18,"column":164,"offset":831}}}],"position":{"start":{"line":18,"column":3,"offset":670},"end":{"line":18,"column":164,"offset":831}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contentRect","position":{"start":{"line":19,"column":5,"offset":836},"end":{"line":19,"column":18,"offset":849}}}],"position":{"start":{"line":19,"column":5,"offset":836},"end":{"line":19,"column":18,"offset":849}}},{"type":"text","value":" ","position":{"start":{"line":19,"column":18,"offset":849},"end":{"line":19,"column":19,"offset":850}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/rectangle"},"children":[{"type":"text","value":"Rectangle"}]},{"type":"text","value":" - The region of the video frame that capturer would like to populate. In OSR case, it is the same with ","position":{"start":{"line":19,"column":44,"offset":875},"end":{"line":19,"column":148,"offset":979}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"dirtyRect","position":{"start":{"line":19,"column":148,"offset":979},"end":{"line":19,"column":159,"offset":990}}}],"position":{"start":{"line":19,"column":148,"offset":979},"end":{"line":19,"column":159,"offset":990}}},{"type":"text","value":" that needs to be painted.","position":{"start":{"line":19,"column":159,"offset":990},"end":{"line":19,"column":185,"offset":1016}}}],"position":{"start":{"line":19,"column":3,"offset":834},"end":{"line":19,"column":185,"offset":1016}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"timestamp","position":{"start":{"line":20,"column":5,"offset":1021},"end":{"line":20,"column":16,"offset":1032}}}],"position":{"start":{"line":20,"column":5,"offset":1021},"end":{"line":20,"column":16,"offset":1032}}},{"type":"text","value":" number - The time in microseconds since the capture start.","position":{"start":{"line":20,"column":16,"offset":1032},"end":{"line":20,"column":75,"offset":1091}}}],"position":{"start":{"line":20,"column":3,"offset":1019},"end":{"line":20,"column":75,"offset":1091}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"metadata","position":{"start":{"line":21,"column":5,"offset":1096},"end":{"line":21,"column":15,"offset":1106}}}],"position":{"start":{"line":21,"column":5,"offset":1096},"end":{"line":21,"column":15,"offset":1106}}},{"type":"text","value":" Object - Extra metadata. See comments in src\\\\media\\\\base\\\\video_frame_metadata.h for accurate details.","position":{"start":{"line":21,"column":15,"offset":1106},"end":{"line":21,"column":116,"offset":1207}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"captureUpdateRect","position":{"start":{"line":22,"column":7,"offset":1214},"end":{"line":22,"column":26,"offset":1233}}}],"position":{"start":{"line":22,"column":7,"offset":1214},"end":{"line":22,"column":26,"offset":1233}}},{"type":"text","value":" ","position":{"start":{"line":22,"column":26,"offset":1233},"end":{"line":22,"column":27,"offset":1234}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/rectangle"},"children":[{"type":"text","value":"Rectangle"}]},{"type":"text","value":" (optional) - Updated area of frame, can be considered as the ","position":{"start":{"line":22,"column":52,"offset":1259},"end":{"line":22,"column":114,"offset":1321}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"dirty","position":{"start":{"line":22,"column":114,"offset":1321},"end":{"line":22,"column":121,"offset":1328}}}],"position":{"start":{"line":22,"column":114,"offset":1321},"end":{"line":22,"column":121,"offset":1328}}},{"type":"text","value":" area.","position":{"start":{"line":22,"column":121,"offset":1328},"end":{"line":22,"column":127,"offset":1334}}}],"position":{"start":{"line":22,"column":5,"offset":1212},"end":{"line":22,"column":127,"offset":1334}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"regionCaptureRect","position":{"start":{"line":23,"column":7,"offset":1341},"end":{"line":23,"column":26,"offset":1360}}}],"position":{"start":{"line":23,"column":7,"offset":1341},"end":{"line":23,"column":26,"offset":1360}}},{"type":"text","value":" ","position":{"start":{"line":23,"column":26,"offset":1360},"end":{"line":23,"column":27,"offset":1361}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/rectangle"},"children":[{"type":"text","value":"Rectangle"}]},{"type":"text","value":" (optional) - May reflect the frame\'s contents origin if region capture is used internally.","position":{"start":{"line":23,"column":52,"offset":1386},"end":{"line":23,"column":143,"offset":1477}}}],"position":{"start":{"line":23,"column":5,"offset":1339},"end":{"line":23,"column":143,"offset":1477}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"sourceSize","position":{"start":{"line":24,"column":7,"offset":1484},"end":{"line":24,"column":19,"offset":1496}}}],"position":{"start":{"line":24,"column":7,"offset":1484},"end":{"line":24,"column":19,"offset":1496}}},{"type":"text","value":" ","position":{"start":{"line":24,"column":19,"offset":1496},"end":{"line":24,"column":20,"offset":1497}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/rectangle"},"children":[{"type":"text","value":"Rectangle"}]},{"type":"text","value":" (optional) - Full size of the source frame.","position":{"start":{"line":24,"column":45,"offset":1522},"end":{"line":24,"column":89,"offset":1566}}}],"position":{"start":{"line":24,"column":5,"offset":1482},"end":{"line":24,"column":89,"offset":1566}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"frameCount","position":{"start":{"line":25,"column":7,"offset":1573},"end":{"line":25,"column":19,"offset":1585}}}],"position":{"start":{"line":25,"column":7,"offset":1573},"end":{"line":25,"column":19,"offset":1585}}},{"type":"text","value":" number (optional) - The increasing count of captured frame. May contain gaps if frames are dropped between two consecutively received frames.","position":{"start":{"line":25,"column":19,"offset":1585},"end":{"line":25,"column":161,"offset":1727}}}],"position":{"start":{"line":25,"column":5,"offset":1571},"end":{"line":25,"column":161,"offset":1727}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":22,"column":5,"offset":1212},"end":{"line":25,"column":161,"offset":1727}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":21,"column":3,"offset":1094},"end":{"line":25,"column":161,"offset":1727}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"handle","position":{"start":{"line":26,"column":5,"offset":1732},"end":{"line":26,"column":13,"offset":1740}}}],"position":{"start":{"line":26,"column":5,"offset":1732},"end":{"line":26,"column":13,"offset":1740}}},{"type":"text","value":" ","position":{"start":{"line":26,"column":13,"offset":1740},"end":{"line":26,"column":14,"offset":1741}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/shared-texture-handle"},"children":[{"type":"text","value":"SharedTextureHandle"}]},{"type":"text","value":" - The shared texture handle data.","position":{"start":{"line":26,"column":61,"offset":1788},"end":{"line":26,"column":95,"offset":1822}}}],"position":{"start":{"line":26,"column":3,"offset":1730},"end":{"line":26,"column":95,"offset":1822}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":11,"column":3,"offset":198},"end":{"line":26,"column":95,"offset":1822}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":146},"end":{"line":26,"column":95,"offset":1822}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"release","position":{"start":{"line":27,"column":3,"offset":1825},"end":{"line":27,"column":12,"offset":1834}}}],"position":{"start":{"line":27,"column":3,"offset":1825},"end":{"line":27,"column":12,"offset":1834}}},{"type":"text","value":" Function - Release the resources. The ","position":{"start":{"line":27,"column":12,"offset":1834},"end":{"line":27,"column":51,"offset":1873}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"texture","position":{"start":{"line":27,"column":51,"offset":1873},"end":{"line":27,"column":60,"offset":1882}}}],"position":{"start":{"line":27,"column":51,"offset":1873},"end":{"line":27,"column":60,"offset":1882}}},{"type":"text","value":" cannot be directly passed to another process, users need to maintain texture lifecycles in\\nmain process, but it is safe to pass the ","position":{"start":{"line":27,"column":60,"offset":1882},"end":{"line":28,"column":44,"offset":2017}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"textureInfo","position":{"start":{"line":28,"column":44,"offset":2017},"end":{"line":28,"column":57,"offset":2030}}}],"position":{"start":{"line":28,"column":44,"offset":2017},"end":{"line":28,"column":57,"offset":2030}}},{"type":"text","value":" to another process. Only a limited number of textures can exist at the same time, so it\'s important that you call ","position":{"start":{"line":28,"column":57,"offset":2030},"end":{"line":28,"column":172,"offset":2145}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"texture.release()","position":{"start":{"line":28,"column":172,"offset":2145},"end":{"line":28,"column":191,"offset":2164}}}],"position":{"start":{"line":28,"column":172,"offset":2145},"end":{"line":28,"column":191,"offset":2164}}},{"type":"text","value":" as soon as you\'re done with the texture.","position":{"start":{"line":28,"column":191,"offset":2164},"end":{"line":28,"column":232,"offset":2205}}}],"position":{"start":{"line":27,"column":1,"offset":1823},"end":{"line":28,"column":232,"offset":2205}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":146},"end":{"line":28,"column":232,"offset":2205}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":29,"column":1,"offset":2206}}}'})," (optional) ",(0,i.jsx)(t.em,{className:"badge badge--warning",children:"Experimental"})," - The GPU shared texture of the frame, when ",(0,i.jsx)(t.code,{children:"webPreferences.offscreen.useSharedTexture"})," is ",(0,i.jsx)(t.code,{children:"true"}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"dirtyRect"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/rectangle",title:"Rectangle",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Rectangle Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}}],"position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}},{"type":"text","value":" number - The x coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":10,"column":6,"offset":110},"end":{"line":10,"column":85,"offset":189}}}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":10,"column":85,"offset":189}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}}],"position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}},{"type":"text","value":" number - The y coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":11,"column":6,"offset":195},"end":{"line":11,"column":85,"offset":274}}}],"position":{"start":{"line":11,"column":1,"offset":190},"end":{"line":11,"column":85,"offset":274}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}}],"position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}},{"type":"text","value":" number - The width of the rectangle (must be an integer).","position":{"start":{"line":12,"column":10,"offset":284},"end":{"line":12,"column":68,"offset":342}}}],"position":{"start":{"line":12,"column":1,"offset":275},"end":{"line":12,"column":68,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}}],"position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}},{"type":"text","value":" number - The height of the rectangle (must be an integer).","position":{"start":{"line":13,"column":11,"offset":353},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":13,"column":1,"offset":343},"end":{"line":13,"column":70,"offset":412}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":14,"column":1,"offset":413}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"image"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:"NativeImage"})," - The image data of the whole frame."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when a new frame is generated. Only the dirty area is passed in the buffer."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ webPreferences: { offscreen: true } })\nwin.webContents.on('paint', (event, dirty, image) => {\n  // updateBitmap(dirty, image.toBitmap())\n})\nwin.loadURL('https://github.com')\n"})}),"\n",(0,i.jsxs)(t.p,{children:["When using shared texture (set ",(0,i.jsx)(t.code,{children:"webPreferences.offscreen.useSharedTexture"})," to ",(0,i.jsx)(t.code,{children:"true"}),") feature, you can pass the texture handle to external rendering pipeline without the overhead of\ncopying data between CPU and GPU memory, with Chromium's hardware acceleration support. This feature is helpful for high-performance rendering scenarios."]}),"\n",(0,i.jsxs)(t.p,{children:["Only a limited number of textures can exist at the same time, so it's important that you call ",(0,i.jsx)(t.code,{children:"texture.release()"})," as soon as you're done with the texture.\nBy managing the

1 texture lifecycle by yourself, you can safely pass the ",(0,i.jsx)(t.code,{children:"texture.textureInfo"})," to other processes through IPC."]}),"\n",(0,i.jsxs)(t.p,{children:["More details can be found in the ",(0,i.jsx)(t.a,{href:"/docs/latest/tutorial/offscreen-rendering",children:"offscreen rendering tutorial"}),". To learn about how to handle the texture in native code, refer to ",(0,i.jsx)(t.a,{href:"https://github.com/electron/electron/blob/v44.4.5/shell/browser/osr/README.md",children:"offscreen rendering's code documentation."}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ webPreferences: { offscreen: { useSharedTexture: true } } })\nwin.webContents.on('paint', async (e, dirty, image) => {\n  if (e.texture) {\n    // By managing lifecycle yourself, you can handle the event in async handler or pass the `e.texture.textureInfo`\n    // to other processes (not `e.texture`, the `e.texture.release` function is not passable through IPC).\n    await new Promise((resolve) => setTimeout(resolve, 50))\n\n    // You can send the native texture handle to native code for importing into your rendering pipeline.\n    // Read more at https://github.com/electron/electron/blob/main/shell/browser/osr/README.md\n    // importTextureHandle(dirty, e.texture.textureInfo)\n\n    // You must call `e.texture.release()` as soon as possible, before the underlying frame pool is drained.\n    e.texture.release()\n  }\n})\nwin.loadURL('https://github.com')\n"})}),"\n",(0,i.jsx)(t.h4,{id:"event-devtools-reload-page",children:"Event: 'devtools-reload-page'"}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the DevTools window instructs the webContents to reload"}),"\n",(0,i.jsx)(t.h4,{id:"event-will-attach-webview",children:"Event: 'will-attach-webview'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"webPreferences"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/structures/web-preferences",children:"WebPreferences"})," - The web preferences that will be used by the guest\npage. This object can be modified to adjust the preferences for the guest\npage."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"params"})," Record<string, string> - The other ",(0,i.jsx)(t.code,{children:"<webview>"})," parameters such as the ",(0,i.jsx)(t.code,{children:"src"})," URL.\nThis object can be modified to adjust the parameters of the guest page."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a ",(0,i.jsx)(t.code,{children:"<webview>"}),"'s web contents is being attached to this web\ncontents. Calling ",(0,i.jsx)(t.code,{children:"event.preventDefault()"})," will destroy the guest page."]}),"\n",(0,i.jsxs)(t.p,{children:["This event can be used to configure ",(0,i.jsx)(t.code,{children:"webPreferences"})," for the ",(0,i.jsx)(t.code,{children:"webContents"}),"\nof a ",(0,i.jsx)(t.code,{children:"<webview>"})," before it's loaded, and provides the ability to set settings\nthat can't be set via ",(0,i.jsx)(t.code,{children:"<webview>"})," attributes."]}),"\n",(0,i.jsx)(t.h4,{id:"event-did-attach-webview",children:"Event: 'did-attach-webview'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"webContents"})," WebContents - The guest web contents that is used by the\n",(0,i.jsx)(t.code,{children:"<webview>"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when a ",(0,i.jsx)(t.code,{children:"<webview>"})," has been attached to this web contents."]}),"\n",(0,i.jsx)(t.h4,{id:"event-console-message",children:"Event: 'console-message'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Event<>","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"message"})," string - Message text"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"level"})," string - Message severity\nPossible values include ",(0,i.jsx)(t.code,{children:"info"}),", ",(0,i.jsx)(t.code,{children:"warning"}),", ",(0,i.jsx)(t.code,{children:"error"}),", and ",(0,i.jsx)(t.code,{children:"debug"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"lineNumber"})," Integer - Line number in the log source"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"sourceId"})," string - URL of the log source"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain - Frame that logged the message"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"level"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})," - The log level, from 0 to 3. In order it matches ",(0,i.jsx)(t.code,{children:"verbose"}),", ",(0,i.jsx)(t.code,{children:"info"}),", ",(0,i.jsx)(t.code,{children:"warning"})," and ",(0,i.jsx)(t.code,{children:"error"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"message"})," string ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})," - The actual console message"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"line"})," Integer ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})," - The line number of the source that triggered this console message"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"sourceId"})," string ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Emitted when the associated window logs a console message."}),"\n",(0,i.jsx)(t.h4,{id:"event-preload-error",children:"Event: 'preload-error'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"preloadPath"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"error"})," Error"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the preload script ",(0,i.jsx)(t.code,{children:"preloadPath"})," throws an unhandled exception ",(0,i.jsx)(t.code,{children:"error"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-ipc-message",children:"Event: 'ipc-message'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/ipc-main-event",title:"IpcMainEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"IpcMainEvent Object extends

1Event"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":150},"end":{"line":10,"column":9,"offset":156}}}],"position":{"start":{"line":10,"column":3,"offset":150},"end":{"line":10,"column":9,"offset":156}}},{"type":"text","value":" String - Possible values include ","position":{"start":{"line":10,"column":9,"offset":156},"end":{"line":10,"column":43,"offset":190}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"frame","position":{"start":{"line":10,"column":43,"offset":190},"end":{"line":10,"column":50,"offset":197}}}],"position":{"start":{"line":10,"column":43,"offset":190},"end":{"line":10,"column":50,"offset":197}}}],"position":{"start":{"line":10,"column":1,"offset":148},"end":{"line":10,"column":50,"offset":197}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"processId","position":{"start":{"line":11,"column":3,"offset":200},"end":{"line":11,"column":14,"offset":211}}}],"position":{"start":{"line":11,"column":3,"offset":200},"end":{"line":11,"column":14,"offset":211}}},{"type":"text","value":" Integer - The internal ID of the renderer process that sent this message","position":{"start":{"line":11,"column":14,"offset":211},"end":{"line":11,"column":87,"offset":284}}}],"position":{"start":{"line":11,"column":1,"offset":198},"end":{"line":11,"column":87,"offset":284}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"frameId","position":{"start":{"line":12,"column":3,"offset":287},"end":{"line":12,"column":12,"offset":296}}}],"position":{"start":{"line":12,"column":3,"offset":287},"end":{"line":12,"column":12,"offset":296}}},{"type":"text","value":" Integer - The ID of the renderer frame that sent this message","position":{"start":{"line":12,"column":12,"offset":296},"end":{"line":12,"column":74,"offset":358}}}],"position":{"start":{"line":12,"column":1,"offset":285},"end":{"line":12,"column":74,"offset":358}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"returnValue","position":{"start":{"line":13,"column":3,"offset":361},"end":{"line":13,"column":16,"offset":374}}}],"position":{"start":{"line":13,"column":3,"offset":361},"end":{"line":13,"column":16,"offset":374}}},{"type":"text","value":" any - Set this to the value to be returned in a synchronous message","position":{"start":{"line":13,"column":16,"offset":374},"end":{"line":13,"column":84,"offset":442}}}],"position":{"start":{"line":13,"column":1,"offset":359},"end":{"line":13,"column":84,"offset":442}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"sender","position":{"start":{"line":14,"column":3,"offset":445},"end":{"line":14,"column":11,"offset":453}}}],"position":{"start":{"line":14,"column":3,"offset":445},"end":{"line":14,"column":11,"offset":453}}},{"type":"text","value":" ","position":{"start":{"line":14,"column":11,"offset":453},"end":{"line":14,"column":12,"offset":454}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/web-contents"},"children":[{"type":"text","value":"WebContents","position":{"start":{"line":14,"column":13,"offset":455},"end":{"line":14,"column":24,"offset":466}}}],"position":{"start":{"line":14,"column":12,"offset":454},"end":{"line":14,"column":45,"offset":487}}},{"type":"text","value":" - Returns the ","position":{"start":{"line":14,"column":45,"offset":487},"end":{"line":14,"column":60,"offset":502}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"webContents","position":{"start":{"line":14,"column":60,"offset":502},"end":{"line":14,"column":73,"offset":515}}}],"position":{"start":{"line":14,"column":60,"offset":502},"end":{"line":14,"column":73,"offset":515}}},{"type":"text","value":" that sent the message","position":{"start":{"line":14,"column":73,"offset":515},"end":{"line":14,"column":95,"offset":537}}}],"position":{"start":{"line":14,"column":1,"offset":443},"end":{"line":14,"column":95,"offset":537}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"senderFrame","position":{"start":{"line":15,"column":3,"offset":540},"end":{"line":15,"column":16,"offset":553}}}],"position":{"start":{"line":15,"column":3,"offset":540},"end":{"line":15,"column":16,"offset":553}}},{"type":"text","value":" ","position":{"start":{"line":15,"column":16,"offset":553},"end":{"line":15,"column":17,"offset":554}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/web-frame-main"},"children":[{"type":"text","value":"WebFrameMain","position":{"start":{"line":15,"column":18,"offset":555},"end":{"line":15,"column":30,"offset":567}}}],"position":{"start":{"line":15,"column":17,"offset":554},"end":{"line":15,"column":53,"offset":590}}},{"type":"text","value":" | null ","position":{"start":{"line":15,"column":53,"offset":590},"end":{"line":15,"column":61,"offset":598}}},{"type":"element","tagName":"em","properties":{"className":["badge badge--info"]},"children":[{"type":"text","value":"Readonly","position":{"start":{"line":15,"column":62,"offset":599},"end":{"line":15,"column":70,"offset":607}}}],"position":{"start":{"line":15,"column":61,"offset":598},"end":{"line":15,"column":71,"offset":608}}},{"type":"text","value":" - The frame that sent this message. May be ","position":{"start":{"line":15,"column":71,"offset":608},"end":{"line":15,"column":115,"offset":652}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"null","position":{"start":{"line":15,"column":115,"offset":652},"end":{"line":15,"column":121,"offset":658}}}],"position":{"start":{"line":15,"column":115,"offset":652},"end":{"line":15,"column":121,"offset":658}}},{"type":"text","value":" if accessed after the frame has either navigated or been destroyed.","position":{"start":{"line":15,"column":121,"offset":658},"end":{"line":15,"column":189,"offset":726}}}],"position":{"start":{"line":15,"column":1,"offset":538},"end":{"line":15,"column":189,"offset":726}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ports","position":{"start":{"line":16,"column":3,"offset":729},"end":{"line":16,"column":10,"offset":736}}}],"position":{"start":{"line":16,"column":3,"offset":729},"end":{"line":16,"column":10,"offset":736}}},{"type":"text","value":" ","position":{"start":{"line":16,"column":10,"offset":736},"end":{"line":16,"column":11,"offset":737}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/message-port

1-main"},"children":[{"type":"text","value":"MessagePortMain","position":{"start":{"line":16,"column":12,"offset":738},"end":{"line":16,"column":27,"offset":753}}}],"position":{"start":{"line":16,"column":11,"offset":737},"end":{"line":16,"column":53,"offset":779}}},{"type":"text","value":"[] - A list of MessagePorts that were transferred with this message","position":{"start":{"line":16,"column":53,"offset":779},"end":{"line":16,"column":120,"offset":846}}}],"position":{"start":{"line":16,"column":1,"offset":727},"end":{"line":16,"column":120,"offset":846}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"reply","position":{"start":{"line":17,"column":3,"offset":849},"end":{"line":17,"column":10,"offset":856}}}],"position":{"start":{"line":17,"column":3,"offset":849},"end":{"line":17,"column":10,"offset":856}}},{"type":"text","value":" Function - A function that will send an IPC message to the renderer frame that sent the original message that you are currently handling.  You should use this method to \\"reply\\" to the sent message in order to guarantee the reply will go to the correct process and frame.","position":{"start":{"line":17,"column":10,"offset":856},"end":{"line":17,"column":281,"offset":1127}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"channel","position":{"start":{"line":18,"column":5,"offset":1132},"end":{"line":18,"column":14,"offset":1141}}}],"position":{"start":{"line":18,"column":5,"offset":1132},"end":{"line":18,"column":14,"offset":1141}}},{"type":"text","value":" string","position":{"start":{"line":18,"column":14,"offset":1141},"end":{"line":18,"column":21,"offset":1148}}}],"position":{"start":{"line":18,"column":3,"offset":1130},"end":{"line":18,"column":21,"offset":1148}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"...args","position":{"start":{"line":19,"column":5,"offset":1153},"end":{"line":19,"column":14,"offset":1162}}}],"position":{"start":{"line":19,"column":5,"offset":1153},"end":{"line":19,"column":14,"offset":1162}}},{"type":"text","value":" any[]","position":{"start":{"line":19,"column":14,"offset":1162},"end":{"line":19,"column":20,"offset":1168}}}],"position":{"start":{"line":19,"column":3,"offset":1151},"end":{"line":19,"column":20,"offset":1168}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":18,"column":3,"offset":1130},"end":{"line":19,"column":20,"offset":1168}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":17,"column":1,"offset":847},"end":{"line":19,"column":20,"offset":1168}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":148},"end":{"line":19,"column":20,"offset":1168}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":1169}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"channel"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"...args"})," any[]"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the renderer process sends an asynchronous message via ",(0,i.jsx)(t.code,{children:"ipcRenderer.send()"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["See also ",(0,i.jsx)(t.a,{href:"#contentsipc-readonly",children:(0,i.jsx)(t.code,{children:"webContents.ipc"})}),", which provides an ",(0,i.jsx)(t.a,{href:"/docs/latest/api/ipc-main",children:(0,i.jsx)(t.code,{children:"IpcMain"})}),"-like interface for responding to IPC messages specifically from this WebContents."]}),"\n",(0,i.jsx)(t.h4,{id:"event-ipc-message-sync",children:"Event: 'ipc-message-sync'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/ipc-main-event",title:"IpcMainEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"IpcMainEvent Object extends

1Event"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":150},"end":{"line":10,"column":9,"offset":156}}}],"position":{"start":{"line":10,"column":3,"offset":150},"end":{"line":10,"column":9,"offset":156}}},{"type":"text","value":" String - Possible values include ","position":{"start":{"line":10,"column":9,"offset":156},"end":{"line":10,"column":43,"offset":190}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"frame","position":{"start":{"line":10,"column":43,"offset":190},"end":{"line":10,"column":50,"offset":197}}}],"position":{"start":{"line":10,"column":43,"offset":190},"end":{"line":10,"column":50,"offset":197}}}],"position":{"start":{"line":10,"column":1,"offset":148},"end":{"line":10,"column":50,"offset":197}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"processId","position":{"start":{"line":11,"column":3,"offset":200},"end":{"line":11,"column":14,"offset":211}}}],"position":{"start":{"line":11,"column":3,"offset":200},"end":{"line":11,"column":14,"offset":211}}},{"type":"text","value":" Integer - The internal ID of the renderer process that sent this message","position":{"start":{"line":11,"column":14,"offset":211},"end":{"line":11,"column":87,"offset":284}}}],"position":{"start":{"line":11,"column":1,"offset":198},"end":{"line":11,"column":87,"offset":284}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"frameId","position":{"start":{"line":12,"column":3,"offset":287},"end":{"line":12,"column":12,"offset":296}}}],"position":{"start":{"line":12,"column":3,"offset":287},"end":{"line":12,"column":12,"offset":296}}},{"type":"text","value":" Integer - The ID of the renderer frame that sent this message","position":{"start":{"line":12,"column":12,"offset":296},"end":{"line":12,"column":74,"offset":358}}}],"position":{"start":{"line":12,"column":1,"offset":285},"end":{"line":12,"column":74,"offset":358}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"returnValue","position":{"start":{"line":13,"column":3,"offset":361},"end":{"line":13,"column":16,"offset":374}}}],"position":{"start":{"line":13,"column":3,"offset":361},"end":{"line":13,"column":16,"offset":374}}},{"type":"text","value":" any - Set this to the value to be returned in a synchronous message","position":{"start":{"line":13,"column":16,"offset":374},"end":{"line":13,"column":84,"offset":442}}}],"position":{"start":{"line":13,"column":1,"offset":359},"end":{"line":13,"column":84,"offset":442}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"sender","position":{"start":{"line":14,"column":3,"offset":445},"end":{"line":14,"column":11,"offset":453}}}],"position":{"start":{"line":14,"column":3,"offset":445},"end":{"line":14,"column":11,"offset":453}}},{"type":"text","value":" ","position":{"start":{"line":14,"column":11,"offset":453},"end":{"line":14,"column":12,"offset":454}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/web-contents"},"children":[{"type":"text","value":"WebContents","position":{"start":{"line":14,"column":13,"offset":455},"end":{"line":14,"column":24,"offset":466}}}],"position":{"start":{"line":14,"column":12,"offset":454},"end":{"line":14,"column":45,"offset":487}}},{"type":"text","value":" - Returns the ","position":{"start":{"line":14,"column":45,"offset":487},"end":{"line":14,"column":60,"offset":502}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"webContents","position":{"start":{"line":14,"column":60,"offset":502},"end":{"line":14,"column":73,"offset":515}}}],"position":{"start":{"line":14,"column":60,"offset":502},"end":{"line":14,"column":73,"offset":515}}},{"type":"text","value":" that sent the message","position":{"start":{"line":14,"column":73,"offset":515},"end":{"line":14,"column":95,"offset":537}}}],"position":{"start":{"line":14,"column":1,"offset":443},"end":{"line":14,"column":95,"offset":537}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"senderFrame","position":{"start":{"line":15,"column":3,"offset":540},"end":{"line":15,"column":16,"offset":553}}}],"position":{"start":{"line":15,"column":3,"offset":540},"end":{"line":15,"column":16,"offset":553}}},{"type":"text","value":" ","position":{"start":{"line":15,"column":16,"offset":553},"end":{"line":15,"column":17,"offset":554}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/web-frame-main"},"children":[{"type":"text","value":"WebFrameMain","position":{"start":{"line":15,"column":18,"offset":555},"end":{"line":15,"column":30,"offset":567}}}],"position":{"start":{"line":15,"column":17,"offset":554},"end":{"line":15,"column":53,"offset":590}}},{"type":"text","value":" | null ","position":{"start":{"line":15,"column":53,"offset":590},"end":{"line":15,"column":61,"offset":598}}},{"type":"element","tagName":"em","properties":{"className":["badge badge--info"]},"children":[{"type":"text","value":"Readonly","position":{"start":{"line":15,"column":62,"offset":599},"end":{"line":15,"column":70,"offset":607}}}],"position":{"start":{"line":15,"column":61,"offset":598},"end":{"line":15,"column":71,"offset":608}}},{"type":"text","value":" - The frame that sent this message. May be ","position":{"start":{"line":15,"column":71,"offset":608},"end":{"line":15,"column":115,"offset":652}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"null","position":{"start":{"line":15,"column":115,"offset":652},"end":{"line":15,"column":121,"offset":658}}}],"position":{"start":{"line":15,"column":115,"offset":652},"end":{"line":15,"column":121,"offset":658}}},{"type":"text","value":" if accessed after the frame has either navigated or been destroyed.","position":{"start":{"line":15,"column":121,"offset":658},"end":{"line":15,"column":189,"offset":726}}}],"position":{"start":{"line":15,"column":1,"offset":538},"end":{"line":15,"column":189,"offset":726}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ports","position":{"start":{"line":16,"column":3,"offset":729},"end":{"line":16,"column":10,"offset":736}}}],"position":{"start":{"line":16,"column":3,"offset":729},"end":{"line":16,"column":10,"offset":736}}},{"type":"text","value":" ","position":{"start":{"line":16,"column":10,"offset":736},"end":{"line":16,"column":11,"offset":737}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/message-port

1-main"},"children":[{"type":"text","value":"MessagePortMain","position":{"start":{"line":16,"column":12,"offset":738},"end":{"line":16,"column":27,"offset":753}}}],"position":{"start":{"line":16,"column":11,"offset":737},"end":{"line":16,"column":53,"offset":779}}},{"type":"text","value":"[] - A list of MessagePorts that were transferred with this message","position":{"start":{"line":16,"column":53,"offset":779},"end":{"line":16,"column":120,"offset":846}}}],"position":{"start":{"line":16,"column":1,"offset":727},"end":{"line":16,"column":120,"offset":846}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"reply","position":{"start":{"line":17,"column":3,"offset":849},"end":{"line":17,"column":10,"offset":856}}}],"position":{"start":{"line":17,"column":3,"offset":849},"end":{"line":17,"column":10,"offset":856}}},{"type":"text","value":" Function - A function that will send an IPC message to the renderer frame that sent the original message that you are currently handling.  You should use this method to \\"reply\\" to the sent message in order to guarantee the reply will go to the correct process and frame.","position":{"start":{"line":17,"column":10,"offset":856},"end":{"line":17,"column":281,"offset":1127}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"channel","position":{"start":{"line":18,"column":5,"offset":1132},"end":{"line":18,"column":14,"offset":1141}}}],"position":{"start":{"line":18,"column":5,"offset":1132},"end":{"line":18,"column":14,"offset":1141}}},{"type":"text","value":" string","position":{"start":{"line":18,"column":14,"offset":1141},"end":{"line":18,"column":21,"offset":1148}}}],"position":{"start":{"line":18,"column":3,"offset":1130},"end":{"line":18,"column":21,"offset":1148}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"...args","position":{"start":{"line":19,"column":5,"offset":1153},"end":{"line":19,"column":14,"offset":1162}}}],"position":{"start":{"line":19,"column":5,"offset":1153},"end":{"line":19,"column":14,"offset":1162}}},{"type":"text","value":" any[]","position":{"start":{"line":19,"column":14,"offset":1162},"end":{"line":19,"column":20,"offset":1168}}}],"position":{"start":{"line":19,"column":3,"offset":1151},"end":{"line":19,"column":20,"offset":1168}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":18,"column":3,"offset":1130},"end":{"line":19,"column":20,"offset":1168}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":17,"column":1,"offset":847},"end":{"line":19,"column":20,"offset":1168}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":148},"end":{"line":19,"column":20,"offset":1168}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":1169}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"channel"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"...args"})," any[]"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the renderer process sends a synchronous message via ",(0,i.jsx)(t.code,{children:"ipcRenderer.sendSync()"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["See also ",(0,i.jsx)(t.a,{href:"#contentsipc-readonly",children:(0,i.jsx)(t.code,{children:"webContents.ipc"})}),", which provides an ",(0,i.jsx)(t.a,{href:"/docs/latest/api/ipc-main",children:(0,i.jsx)(t.code,{children:"IpcMain"})}),"-like interface for responding to IPC messages specifically from this WebContents."]}),"\n",(0,i.jsx)(t.h4,{id:"event-preferred-size-changed",children:"Event: 'preferred-size-changed'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"preferredSize"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/size",title:"Size",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Size Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}}],"position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}},{"type":"text","value":" number","position":{"start":{"line":10,"column":10,"offset":99},"end":{"line":10,"column":17,"offset":106}}}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":10,"column":17,"offset":106}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}}],"position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}},{"type":"text","value":" number","position":{"start":{"line":11,"column":11,"offset":117},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":11,"column":1,"offset":107},"end":{"line":11,"column":18,"offset":124}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":125}}}'})," - The minimum size needed to\ncontain the layout of the document\u2014without requiring scrolling."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the ",(0,i.jsx)(t.code,{children:"WebContents"})," preferred size has changed."]}),"\n",(0,i.jsxs)(t.p,{children:["This event will only be emitted when ",(0,i.jsx)(t.code,{children:"enablePreferredSizeMode"})," is set to ",(0,i.jsx)(t.code,{children:"true"}),"\nin ",(0,i.jsx)(t.code,{children:"webPreferences"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"event-frame-created",children:"Event: 'frame-created'"}),"\n",(0,i.jsx)(t.p,{children:"Returns:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"event"})," Event"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frame"})," WebFrameMain | null - The created frame.\nMay be ",(0,i.jsx)(t.code,{children:"null"})," if accessed after the frame has either navigated or been destroyed."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Emitted when the ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#contentsmainframe-readonly",children:"mainFrame"}),", an ",(0,i.jsx)(t.code,{children:"<iframe>"}),", or a nested ",(0,i.jsx)(t.code,{children:"<iframe>"})," is loaded within the page."]}),"\n",(0,i.jsx)(t.h3,{id:"instance-methods",children:"Instance Methods"}),"\n",(0,i.jsx)(t.h4,{id:"contentsloadurlurl-options",children:(0,i.jsx)(t.code,{children:"contents.loadURL(url[, options])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"httpReferrer"})," (string | ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/referrer",title:"Referrer",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Referrer Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"url","position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}}],"position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}},{"type":"text","value":" string - HTTP Referrer URL.","position":{"start":{"line":10,"column":8,"offset":109},"end":{"line":10,"column":36,"offset":137}}}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":10,"column":36,"offset":137}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"policy","position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}}],"position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":11,"column":11,"offset":148},"end":{"line":11,"column":28,"offset":165}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"default","position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}}],"position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":37,"offset":174},"end":{"line":11,"column":39,"offset":176}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"unsafe-url","position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}}],"position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":51,"offset":188},"end":{"line":12,"column":1,"offset":190}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer-when-downgrade","position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}}],"position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":31,"offset":220},"end":{"line":12,"column":33,"offset":222}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer","position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}}],"position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":46,"offset":235},"end":{"line":12,"column":48,"offset":237}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"origin","position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}}],"position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":56,"offset":245},"end":{"line":13,"column":1,"offset":247}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin-when-cross-origin","position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}}],"position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":36,"offset":282},"end":{"line":13,"column":38,"offset":284}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"same-origin","position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}}],"position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}},{"type":"text","value":" or ","position":{"start":{"line":13,"column":51,"offset":297},"end":{"line":13,"column":55,"offset":301}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin","position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}}],"position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}},{"type":"text","value":".\\nSee the ","position":{"start":{"line":13,"column":70,"offset":316},"end":{"line":14,"column":11,"offset":328}}},{"type":"element","tagName":"a","properties":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy"},"children":[{"type":"text","value":"Referrer-Policy spec","position":{"start":{"line":14,"column":12,"offset":329},"end":{"line":14,"column":32,"offset":349}}}],"position":{"start":{"line":14,"column":11,"offset":328},"end":{"line":14,"column":36,"offset":353}}},{"type":"text","value":" for more details on the\\nmeaning of these values.","position":{"start":{"line":14,"column":36,"offset":353},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":11,"column":1,"offset":138},"end":{"line":15,"column":27,"offset":404}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":18,"column":1,"offset":485}}}'}),") (optional) - An HTTP Referrer url."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"userAgent"})," string (optional) - A user agent originating the request."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"extraHeaders"}),' string (optional) - Extra headers separated by "\\n".']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"postData"})," (",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/upload-raw-data",title:"UploadRawData",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"UploadRawData Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":121},"end":{"line":10,"column":9,"offset":127}}}],"position":{"start":{"line":10,"column":3,"offset":121},"end":{"line":10,"column":9,"offset":127}}},{"type":"text","value":" \'rawData\' - ","position":{"start":{"line":10,"column":9,"offset":127},"end":{"line":10,"column":22,"offset":140}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rawData","position":{"start":{"line":10,"column":22,"offset":140},"end":{"line":10,"column":31,"offset":149}}}],"position":{"start":{"line":10,"column":22,"offset":140},"end":{"line":10,"column":31,"offset":149}}},{"type":"text","value":".","position":{"start":{"line":10,"column":31,"offset":149},"end":{"line":10,"column":32,"offset":150}}}],"position":{"start":{"line":10,"column":1,"offset":119},"end":{"line":10,"column":32,"offset":150}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"bytes","position":{"start":{"line":11,"column":3,"offset":153},"end":{"line":11,"column":10,"offset":160}}}],"position":{"start":{"line":11,"column":3,"offset":153},"end":{"line":11,"column":10,"offset":160}}},{"type":"text","value":" Buffer - Data to be uploaded.","position":{"start":{"line":11,"column":10,"offset":160},"end":{"line":11,"column":40,"offset":190}}}],"position":{"start":{"line":11,"column":1,"offset":151},"end":{"line":11,"column":40,"offset":190}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":119},"end":{

1"line":11,"column":40,"offset":190}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":191}}}'})," | ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/upload-file",title:"UploadFile",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"UploadFile Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}}],"position":{"start":{"line":10,"column":3,"offset":111},"end":{"line":10,"column":9,"offset":117}}},{"type":"text","value":" \'file\' - ","position":{"start":{"line":10,"column":9,"offset":117},"end":{"line":10,"column":19,"offset":127}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"file","position":{"start":{"line":10,"column":19,"offset":127},"end":{"line":10,"column":25,"offset":133}}}],"position":{"start":{"line":10,"column":19,"offset":127},"end":{"line":10,"column":25,"offset":133}}},{"type":"text","value":".","position":{"start":{"line":10,"column":25,"offset":133},"end":{"line":10,"column":26,"offset":134}}}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":10,"column":26,"offset":134}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"filePath","position":{"start":{"line":11,"column":3,"offset":137},"end":{"line":11,"column":13,"offset":147}}}],"position":{"start":{"line":11,"column":3,"offset":137},"end":{"line":11,"column":13,"offset":147}}},{"type":"text","value":" string - Path of file to be uploaded.","position":{"start":{"line":11,"column":13,"offset":147},"end":{"line":11,"column":51,"offset":185}}}],"position":{"start":{"line":11,"column":1,"offset":135},"end":{"line":11,"column":51,"offset":185}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"offset","position":{"start":{"line":12,"column":3,"offset":188},"end":{"line":12,"column":11,"offset":196}}}],"position":{"start":{"line":12,"column":3,"offset":188},"end":{"line":12,"column":11,"offset":196}}},{"type":"text","value":" Integer (optional) - Defaults to ","position":{"start":{"line":12,"column":11,"offset":196},"end":{"line":12,"column":45,"offset":230}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"0","position":{"start":{"line":12,"column":45,"offset":230},"end":{"line":12,"column":48,"offset":233}}}],"position":{"start":{"line":12,"column":45,"offset":230},"end":{"line":12,"column":48,"offset":233}}},{"type":"text","value":".","position":{"start":{"line":12,"column":48,"offset":233},"end":{"line":12,"column":49,"offset":234}}}],"position":{"start":{"line":12,"column":1,"offset":186},"end":{"line":12,"column":49,"offset":234}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"length","position":{"start":{"line":13,"column":3,"offset":237},"end":{"line":13,"column":11,"offset":245}}}],"position":{"start":{"line":13,"column":3,"offset":237},"end":{"line":13,"column":11,"offset":245}}},{"type":"text","value":" Integer (optional) - Number of bytes to read from ","position":{"start":{"line":13,"column":11,"offset":245},"end":{"line":13,"column":62,"offset":296}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"offset","position":{"start":{"line":13,"column":62,"offset":296},"end":{"line":13,"column":70,"offset":304}}}],"position":{"start":{"line":13,"column":62,"offset":296},"end":{"line":13,"column":70,"offset":304}}},{"type":"text","value":".\\nDefaults to ","position":{"start":{"line":13,"column":70,"offset":304},"end":{"line":14,"column":15,"offset":320}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"0","position":{"start":{"line":14,"column":15,"offset":320},"end":{"line":14,"column":18,"offset":323}}}],"position":{"start":{"line":14,"column":15,"offset":320},"end":{"line":14,"column":18,"offset":323}}},{"type":"text","value":".","position":{"start":{"line":14,"column":18,"offset":323},"end":{"line":14,"column":19,"offset":324}}}],"position":{"start":{"line":13,"column":1,"offset":235},"end":{"line":14,"column":19,"offset":324}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"modificationTime","position":{"start":{"line":15,"column":3,"offset":327},"end":{"line":15,"column":21,"offset":345}}}],"position":{"start":{"line":15,"column":3,"offset":327},"end":{"line":15,"column":21,"offset":345}}},{"type":"text","value":" Double (optional) - Last Modification time in\\nnumber of seconds since the UNIX epoch. Defaults to ","position":{"start":{"line":15,"column":21,"offset":345},"end":{"line":16,"column":55,"offset":446}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"0","position":{"start":{"line":16,"column":55,"offset":446},"end":{"line":16,"column":58,"offset":449}}}],"position":{"start":{"line":16,"column":55,"offset":446},"end":{"line":16,"column":58,"offset":449}}},{"type":"text","value":".","position":{"start":{"line":16,"column":58,"offset":449},"end":{"line":16,"column":59,"offset":450}}}],"position":{"start":{"line":15,"column":1,"offset":325},"end":{"line":16,"column":59,"offset":450}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":109},"end":{"line":16,"column":59,"offset":450}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":17,"column":1,"offset":451}}}'}),")[] (optional)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"baseURLForDataURL"})," string (optional) - Base url (with trailing path separator) for files to be loaded by the data url. This is needed only if the specified ",(0,i.jsx)(t.code,{children:"url"})," is a data url and needs to load other files."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})," - the promise will resolve when the page has finished loading\n(see ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-finish-load",children:(0,i.jsx)(t.code,{children:"did-finish-load"})}),"), and rejects\nif the page fails to load (see\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-fail-load",children:(0,i.jsx)(t.code,{children:"did-fail-load"})}),"). A noop rejection handler is already attached, which avoids unhandled rejection errors. If the existing page has a beforeUnload handler, ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-fail-load",children:(0,i.jsx)(t.code,{children:"did-fail-load"})})," will be called unless ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-fail-load",children:(0,i.jsx)(t.code,{children:"will-prevent-unload"})})," is handled."]}),"\n",(0,i.jsxs)(t.p,{children:["Loads the ",(0,i.jsx)(t.code,{children:"url"})," in the window. The ",(0,i.jsx)(t.code,{children:"url"})," must contain the protocol prefix,\ne.g. the ",(0,i.jsx)(t.code,{children:"http://"})," or ",(0,i.jsx)(t.code,{children:"file://"}),". If the load should bypass http cache then\nuse the ",(0,i.jsx)(t.code,{children:"pragma"})," header to achieve it."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\nconst options = { extraHeaders: 'pragma: no-cache\\n' }\nwin.webContents.loadURL('https://github.com', options)\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsloadfilefilepath-options",children:(0,i.jsx)(t.code,{children:"contents.loadFile(filePath[, options])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"filePath"})," string"]}),"\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"query"})," Record<string, string> (optional) - Passed to ",(0,i.jsx)(t.code,{children:"url.format()"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"search"})," string (optional) - Passed to ",(0,i.jsx)(t.code,{children:"url.format()"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"hash"})," string (optional) - Passed to ",(0,i.jsx)(t.code,{children:"url.format()"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})," - the promise will resolve when the page has finished loading\n(see ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-finish-load",children:(0,i.jsx)(t.code,{children:"did-finish-load"})}),"), and rejects\nif the page fails to load (see ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-did-fail-load",children:(0,i.jsx)(t.code,{children:"did-fail-load"})}),")."]}),"\n",(0,i.jsxs)(t.p,{children:["Loads the given file in the window, ",(0,i.jsx)(t.code,{children:"filePath"})," should be a path to\nan HTML file relative to the root of your application.  For instance\nan app structure like this:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-sh",children:"| root\n| - package.json\n| - src\n|   - main.js\n|   - index.html\n"})}),"\n",(0,i.jsx)(t.p,{children:"Would require code like this"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\nwin.loadFile('src/index.html')\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsdownloadurlurl-options",children:(0,i.jsx)(t.code,{children:"contents.downloadURL(url[, options])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string"]}),"\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"headers"})," Record<string, string> (optional) - HTTP request headers."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Initiates a download of the resource at ",(0,i.jsx)(t.code,{children:"url"})," without navigating. The\n",(0,i.jsx)(t.code,{children:"will-download"})," event of ",(0,i.jsx)(t.code,{children:"session"})," will be triggered."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgeturl",children:(0,i.jsx)(t.code,{children:"contents.getURL()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - The URL of the current web page."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ width: 800, height: 600 })\nwin.loadURL('https://github.com').then(() =>

1 {\n  const currentURL = win.webContents.getURL()\n  console.log(currentURL)\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsgettitle",children:(0,i.jsx)(t.code,{children:"contents.getTitle()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - The title of the current web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsisdestroyed",children:(0,i.jsx)(t.code,{children:"contents.isDestroyed()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the web page is destroyed."]}),"\n",(0,i.jsx)(t.h4,{id:"contentscloseopts",children:(0,i.jsx)(t.code,{children:"contents.close([opts])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"opts"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"waitForBeforeUnload"})," boolean - if true, fire the ",(0,i.jsx)(t.code,{children:"beforeunload"})," event\nbefore closing the page. If the page prevents the unload, the WebContents\nwill not be closed. The ",(0,i.jsx)(t.a,{href:"#event-will-prevent-unload",children:(0,i.jsx)(t.code,{children:"will-prevent-unload"})}),"\nwill be fired if the page requests prevention of unload."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Closes the page, as if the web content had called ",(0,i.jsx)(t.code,{children:"window.close()"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["If the page is successfully closed (i.e. the unload is not prevented by the\npage, or ",(0,i.jsx)(t.code,{children:"waitForBeforeUnload"})," is false or unspecified), the WebContents will\nbe destroyed and no longer usable. The ",(0,i.jsx)(t.a,{href:"#event-destroyed",children:(0,i.jsx)(t.code,{children:"destroyed"})})," event\nwill be emitted."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsfocus",children:(0,i.jsx)(t.code,{children:"contents.focus()"})}),"\n",(0,i.jsx)(t.p,{children:"Focuses the web page."}),"\n",(0,i.jsx)(t.h4,{id:"contentsisfocused",children:(0,i.jsx)(t.code,{children:"contents.isFocused()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the web page is focused."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsisloading",children:(0,i.jsx)(t.code,{children:"contents.isLoading()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether web page is still loading resources."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsisloadingmainframe",children:(0,i.jsx)(t.code,{children:"contents.isLoadingMainFrame()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the main frame (and not just iframes or frames within it) is\nstill loading."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsiswaitingforresponse",children:(0,i.jsx)(t.code,{children:"contents.isWaitingForResponse()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the web page is waiting for a first-response from the main\nresource of the page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsstop",children:(0,i.jsx)(t.code,{children:"contents.stop()"})}),"\n",(0,i.jsx)(t.p,{children:"Stops any pending navigation."}),"\n",(0,i.jsx)(t.h4,{id:"contentsreload",children:(0,i.jsx)(t.code,{children:"contents.reload()"})}),"\n",(0,i.jsx)(t.p,{children:"Reloads the current web page."}),"\n",(0,i.jsx)(t.h4,{id:"contentsreloadignoringcache",children:(0,i.jsx)(t.code,{children:"contents.reloadIgnoringCache()"})}),"\n",(0,i.jsx)(t.p,{children:"Reloads current page and ignores cache."}),"\n",(0,i.jsxs)(t.h4,{id:"contentscangoback-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.canGoBack()"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the browser can go back to previous web page."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorycangoback",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.canGoBack"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentscangoforward-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.canGoForward()"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-

1on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the browser can go forward to next web page."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorycangoforward",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.canGoForward"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentscangotooffsetoffset-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.canGoToOffset(offset)"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"offset"})," Integer"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the web page can go to ",(0,i.jsx)(t.code,{children:"offset"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorycangotooffsetoffset",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.canGoToOffset"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsclearhistory-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.clearHistory()"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsx)(t.p,{children:"Clears the navigation history."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistoryclear",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.clear"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsgoback-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.goBack()"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsx)(t.p,{children:"Makes the browser go back a web page."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorygoback",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.goBack"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsgoforward-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.goForward()"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsx)(t.p,{children:"Makes the browser go forward a web page."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorygoforward",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.goForward"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsgotoindexindex-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.goToIndex(index)"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-

1on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"index"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Navigates browser to the specified absolute web page index."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorygotoindexindex",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.goToIndex"})})," API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsgotooffsetoffset-deprecated",children:[(0,i.jsx)(t.code,{children:"contents.goToOffset(offset)"})," ",(0,i.jsx)(t.em,{className:"badge badge--danger",children:"Deprecated"})]}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"deprecated":[{"pr-url":"https://github.com/electron/electron/pull/41752","breaking-changes-header":"deprecated-clearhistory-cangoback-goback-cangoforward-goforward-gotoindex-cangotooffset-gotooffset-on-webcontents"}]}',prReleaseVersionsJson:'{"41752":{"release":"32.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"offset"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:'Navigates to the specified offset from the "current entry".'}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Deprecated:"})," Should use the new ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history#navigationhistorygotooffsetoffset",children:(0,i.jsx)(t.code,{children:"contents.navigationHistory.goToOffset"})})," API."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsiscrashed",children:(0,i.jsx)(t.code,{children:"contents.isCrashed()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the renderer process has crashed."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsforcefullycrashrenderer",children:(0,i.jsx)(t.code,{children:"contents.forcefullyCrashRenderer()"})}),"\n",(0,i.jsxs)(t.p,{children:["Forcefully terminates the renderer process that is currently hosting this\n",(0,i.jsx)(t.code,{children:"webContents"}),". This will cause the ",(0,i.jsx)(t.code,{children:"render-process-gone"})," event to be emitted\nwith the ",(0,i.jsx)(t.code,{children:"reason=killed || reason=crashed"}),". Please note that some webContents share renderer\nprocesses and therefore calling this method may also crash the host process\nfor other webContents as well."]}),"\n",(0,i.jsxs)(t.p,{children:["Calling ",(0,i.jsx)(t.code,{children:"reload()"})," immediately after calling this\nmethod will force the reload to occur in a new process. This should be used\nwhen this process is unstable or unusable, for instance in order to recover\nfrom the ",(0,i.jsx)(t.code,{children:"unresponsive"})," event."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\n\nwin.webContents.on('unresponsive', async () => {\n  const { response } = await dialog.showMessageBox({\n    message: 'App X has become unresponsive',\n    title: 'Do you want to try forcefully reloading the app?',\n    buttons: ['OK', 'Cancel'],\n    cancelId: 1\n  })\n  if (response === 0) {\n    win.webContents.forcefullyCrashRenderer()\n    win.webContents.reload()\n  }\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentssetuseragentuseragent",children:(0,i.jsx)(t.code,{children:"contents.setUserAgent(userAgent)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"userAgent"})," string"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Overrides the user agent for this web page."}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetuseragent",children:(0,i.jsx)(t.code,{children:"contents.getUserAgent()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - The user agent for this web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsinsertcsscss-options",children:(0,i.jsx)(t.code,{children:"contents.insertCSS(css[, options])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"css"})," string"]}),"\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"cssOrigin"})," string (optional) - Can be 'user' or 'author'. Sets the ",(0,i.jsx)(t.a,{href:"https://www.w3.org/TR/css3-cascade/#cascade-origin",children:"cascade origin"})," of the inserted stylesheet. Default is 'author'."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<string>"})," - A promise that resolves with a key for the inserted CSS that can later be used to remove the CSS via ",(0,i.jsx)(t.code,{children:"contents.removeInsertedCSS(key)"}),"."]}),"\n",(0,i.jsx)(t.p,{children:"Injects CSS into the current web page and returns a unique key for the inserted\nstylesheet."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\nwin.webContents.on('did-finish-load', () => {\n  win.webContents.insertCSS('html, body { background-color: #f00; }')\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsremoveinsertedcsskey",children:(0,i.jsx)(t.code,{children:"contents.removeInsertedCSS(key)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"key"})," string"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})," - Resolves if the removal was successful."]}),"\n",(0,i.jsxs)(t.p,{children:["Removes the inserted CSS from the current web page. The stylesheet is

1identified\nby its key, which is returned from ",(0,i.jsx)(t.code,{children:"contents.insertCSS(css)"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\n\nwin.webContents.on('did-finish-load', async () => {\n  const key = await win.webContents.insertCSS('html, body { background-color: #f00; }')\n  win.webContents.removeInsertedCSS(key)\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsexecutejavascriptcode-usergesture",children:(0,i.jsx)(t.code,{children:"contents.executeJavaScript(code[, userGesture])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"code"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"userGesture"})," boolean (optional) - Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<any>"})," - A promise that resolves with the result of the executed code\nor is rejected if the result of the code is a rejected promise."]}),"\n",(0,i.jsxs)(t.p,{children:["Evaluates ",(0,i.jsx)(t.code,{children:"code"})," in page."]}),"\n",(0,i.jsxs)(t.p,{children:["In the browser window some HTML APIs like ",(0,i.jsx)(t.code,{children:"requestFullScreen"})," can only be\ninvoked by a gesture from the user. Setting ",(0,i.jsx)(t.code,{children:"userGesture"})," to ",(0,i.jsx)(t.code,{children:"true"})," will remove\nthis limitation."]}),"\n",(0,i.jsx)(t.p,{children:"Code execution will be suspended until web page stop loading."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\n\nwin.webContents\n  .executeJavaScript('fetch(\"https://jsonplaceholder.typicode.com/users/1\").then(resp => resp.json())', true)\n  .then((result) => {\n    console.log(result) // Will be the JSON object from the fetch call\n  })\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsexecutejavascriptinisolatedworldworldid-scripts-usergesture",children:(0,i.jsx)(t.code,{children:"contents.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"worldId"})," Integer - The ID of the world to run the javascript in, ",(0,i.jsx)(t.code,{children:"0"})," is the default world, ",(0,i.jsx)(t.code,{children:"999"})," is the world used by Electron's ",(0,i.jsx)(t.code,{children:"contextIsolation"})," feature.  You can provide any integer here."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scripts"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/web-source",title:"WebSource[]",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"WebSource Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"code","position":{"start":{"line":10,"column":3,"offset":108},"end":{"line":10,"column":9,"offset":114}}}],"position":{"start":{"line":10,"column":3,"offset":108},"end":{"line":10,"column":9,"offset":114}}},{"type":"text","value":" string","position":{"start":{"line":10,"column":9,"offset":114},"end":{"line":10,"column":16,"offset":121}}}],"position":{"start":{"line":10,"column":1,"offset":106},"end":{"line":10,"column":16,"offset":121}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"url","position":{"start":{"line":11,"column":3,"offset":124},"end":{"line":11,"column":8,"offset":129}}}],"position":{"start":{"line":11,"column":3,"offset":124},"end":{"line":11,"column":8,"offset":129}}},{"type":"text","value":" string (optional)","position":{"start":{"line":11,"column":8,"offset":129},"end":{"line":11,"column":26,"offset":147}}}],"position":{"start":{"line":11,"column":1,"offset":122},"end":{"line":11,"column":26,"offset":147}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":106},"end":{"line":11,"column":26,"offset":147}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":148}}}'})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"userGesture"})," boolean (optional) - Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<any>"})," - A promise that resolves with the result of the executed code\nor is rejected if the result of the code is a rejected promise."]}),"\n",(0,i.jsxs)(t.p,{children:["Works like ",(0,i.jsx)(t.code,{children:"executeJavaScript"})," but evaluates ",(0,i.jsx)(t.code,{children:"scripts"})," in an isolated context."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetignoremenushortcutsignore",children:(0,i.jsx)(t.code,{children:"contents.setIgnoreMenuShortcuts(ignore)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"ignore"})," boolean"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Ignore application menu shortcuts while this web contents is focused."}),"\n",(0,i.jsx)(t.h4,{id:"contentssetwindowopenhandlerhandler",children:(0,i.jsx)(t.code,{children:"contents.setWindowOpenHandler(handler)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"handler"})," Function<",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/window-open-handler-response",title:"WindowOpenHandlerResponse",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"WindowOpenHandlerResponse Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"action","position":{"start":{"line":10,"column":3,"offset":158},"end":{"line":10,"column":11,"offset":166}}}],"position":{"start":{"line":10,"column":3,"offset":158},"end":{"line":10,"column":11,"offset":166}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":10,"column":11,"offset":166},"end":{"line":10,"column":28,"offset":183}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"allow","position":{"start":{"line":10,"column":28,"offset":183},"end":{"line":10,"column":35,"offset":190}}}],"position":{"start":{"line":10,"column":28,"offset":183},"end":{"line":10,"column":35,"offset":190}}},{"type":"text","value":" or ","position":{"start":{"line":10,"column":35,"offset":190},"end":{"line":10,"column":39,"offset":194}}

1},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"deny","position":{"start":{"line":10,"column":39,"offset":194},"end":{"line":10,"column":45,"offset":200}}}],"position":{"start":{"line":10,"column":39,"offset":194},"end":{"line":10,"column":45,"offset":200}}},{"type":"text","value":". Controls whether new window should be created.","position":{"start":{"line":10,"column":45,"offset":200},"end":{"line":10,"column":93,"offset":248}}}],"position":{"start":{"line":10,"column":1,"offset":156},"end":{"line":10,"column":93,"offset":248}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"overrideBrowserWindowOptions","position":{"start":{"line":11,"column":3,"offset":251},"end":{"line":11,"column":33,"offset":281}}}],"position":{"start":{"line":11,"column":3,"offset":251},"end":{"line":11,"column":33,"offset":281}}},{"type":"text","value":" BrowserWindowConstructorOptions (optional) - Allows customization of the created window.","position":{"start":{"line":11,"column":33,"offset":281},"end":{"line":11,"column":122,"offset":370}}}],"position":{"start":{"line":11,"column":1,"offset":249},"end":{"line":11,"column":122,"offset":370}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"outlivesOpener","position":{"start":{"line":12,"column":3,"offset":373},"end":{"line":12,"column":19,"offset":389}}}],"position":{"start":{"line":12,"column":3,"offset":373},"end":{"line":12,"column":19,"offset":389}}},{"type":"text","value":" boolean (optional) - By default, child windows are closed when their opener is closed. This can be\\nchanged by specifying ","position":{"start":{"line":12,"column":19,"offset":389},"end":{"line":13,"column":25,"offset":513}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"outlivesOpener: true","position":{"start":{"line":13,"column":25,"offset":513},"end":{"line":13,"column":47,"offset":535}}}],"position":{"start":{"line":13,"column":25,"offset":513},"end":{"line":13,"column":47,"offset":535}}},{"type":"text","value":", in which case the opened window will not be closed when its opener is closed.","position":{"start":{"line":13,"column":47,"offset":535},"end":{"line":13,"column":126,"offset":614}}}],"position":{"start":{"line":12,"column":1,"offset":371},"end":{"line":13,"column":126,"offset":614}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"createWindow","position":{"start":{"line":14,"column":3,"offset":617},"end":{"line":14,"column":17,"offset":631}}}],"position":{"start":{"line":14,"column":3,"offset":617},"end":{"line":14,"column":17,"offset":631}}},{"type":"text","value":" (options: BrowserWindowConstructorOptions) => WebContents (optional) - If specified, will be called instead of ","position":{"start":{"line":14,"column":17,"offset":631},"end":{"line":14,"column":129,"offset":743}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"new BrowserWindow","position":{"start":{"line":14,"column":129,"offset":743},"end":{"line":14,"column":148,"offset":762}}}],"position":{"start":{"line":14,"column":129,"offset":743},"end":{"line":14,"column":148,"offset":762}}},{"type":"text","value":" to create the new child window and event ","position":{"start":{"line":14,"column":148,"offset":762},"end":{"line":14,"column":190,"offset":804}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/web-contents#event-did-create-window"},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"did-create-window","position":{"start":{"line":14,"column":191,"offset":805},"end":{"line":14,"column":210,"offset":824}}}],"position":{"start":{"line":14,"column":191,"offset":805},"end":{"line":14,"column":210,"offset":824}}}],"position":{"start":{"line":14,"column":190,"offset":804},"end":{"line":14,"column":255,"offset":869}}},{"type":"text","value":" will not be emitted. Constructed child window should use passed ","position":{"start":{"line":14,"column":255,"offset":869},"end":{"line":14,"column":320,"offset":934}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"options","position":{"start":{"line":14,"column":320,"offset":934},"end":{"line":14,"column":329,"offset":943}}}],"position":{"start":{"line":14,"column":320,"offset":934},"end":{"line":14,"column":329,"offset":943}}},{"type":"text","value":" object. This can be used for example to have the new window open as a BrowserView instead of in a separate window.","position":{"start":{"line":14,"column":329,"offset":943},"end":{"line":14,"column":444,"offset":1058}}}],"position":{"start":{"line":14,"column":1,"offset":615},"end":{"line":14,"column":444,"offset":1058}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":156},"end":{"line":14,"column":444,"offset":1058}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":15,"column":1,"offset":1059}}}'}),">"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"details"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"url"})," string - The ",(0,i.jsx)(t.em,{children:"resolved"})," version of the URL passed to ",(0,i.jsx)(t.code,{children:"window.open()"}),". e.g. opening a window with ",(0,i.jsx)(t.code,{children:"window.open('foo')"})," will yield something like ",(0,i.jsx)(t.code,{children:"https://the-origin/the/current/path/foo"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameName"})," string - Name of the window provided in ",(0,i.jsx)(t.code,{children:"window.open()"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"features"})," string - Comma separated list of window features provided to ",(0,i.jsx)(t.code,{children:"window.open()"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"disposition"})," string - Can be ",(0,i.jsx)(t.code,{children:"default"}),", ",(0,i.jsx)(t.code,{children:"foreground-tab"}),",\n",(0,i.jsx)(t.code,{children:"background-tab"}),", ",(0,i.jsx)(t.code,{children:"new-window"})," or ",(0,i.jsx)(t.code,{children:"other"}

1),". Corresponds to the manner\nan associated link was clicked. See Chromium's\n",(0,i.jsx)(t.a,{href:"https://source.chromium.org/chromium/chromium/src/+/main:ui/base/window_open_disposition.h",children:"WindowOpenDisposition"}),".","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"default"})," - Indicates Chromium deems in-window navigation valid\nfor a window open call."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"foreground-tab"})," - Corresponds to a left click or shift + middle click."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"background-tab"})," - Corresponds to a middle click or ctrl/cmd + click."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"new-window"})," - Corresponds to a shift + left click."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"other"})," - A catch-all for the remaining Chromium dispositions not\nhandled by Electron."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"referrer"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/referrer",title:"Referrer",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Referrer Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"url","position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}}],"position":{"start":{"line":10,"column":3,"offset":104},"end":{"line":10,"column":8,"offset":109}}},{"type":"text","value":" string - HTTP Referrer URL.","position":{"start":{"line":10,"column":8,"offset":109},"end":{"line":10,"column":36,"offset":137}}}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":10,"column":36,"offset":137}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"policy","position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}}],"position":{"start":{"line":11,"column":3,"offset":140},"end":{"line":11,"column":11,"offset":148}}},{"type":"text","value":" string - Can be ","position":{"start":{"line":11,"column":11,"offset":148},"end":{"line":11,"column":28,"offset":165}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"default","position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}}],"position":{"start":{"line":11,"column":28,"offset":165},"end":{"line":11,"column":37,"offset":174}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":37,"offset":174},"end":{"line":11,"column":39,"offset":176}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"unsafe-url","position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}}],"position":{"start":{"line":11,"column":39,"offset":176},"end":{"line":11,"column":51,"offset":188}}},{"type":"text","value":",\\n","position":{"start":{"line":11,"column":51,"offset":188},"end":{"line":12,"column":1,"offset":190}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer-when-downgrade","position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}}],"position":{"start":{"line":12,"column":3,"offset":192},"end":{"line":12,"column":31,"offset":220}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":31,"offset":220},"end":{"line":12,"column":33,"offset":222}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"no-referrer","position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}}],"position":{"start":{"line":12,"column":33,"offset":222},"end":{"line":12,"column":46,"offset":235}}},{"type":"text","value":", ","position":{"start":{"line":12,"column":46,"offset":235},"end":{"line":12,"column":48,"offset":237}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"origin","position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}}],"position":{"start":{"line":12,"column":48,"offset":237},"end":{"line":12,"column":56,"offset":245}}},{"type":"text","value":",\\n","position":{"start":{"line":12,"column":56,"offset":245},"end":{"line":13,"column":1,"offset":247}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin-when-cross-origin","position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}}],"position":{"start":{"line":13,"column":3,"offset":249},"end":{"line":13,"column":36,"offset":282}}},{"type":"text","value":", ","position":{"start":{"line":13,"column":36,"offset":282},"end":{"line":13,"column":38,"offset":284}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"same-origin","position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}}],"position":{"start":{"line":13,"column":38,"offset":284},"end":{"line":13,"column":51,"offset":297}}},{"type":"text","value":" or ","position":{"start":{"line":13,"column":51,"offset":297},"end":{"line":13,"column":55,"offset":301}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"strict-origin","position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}}],"position":{"start":{"line":13,"column":55,"offset":301},"end":{"line":13,"column":70,"offset":316}}},{"type":"text","value":".\\nSee the ","position":{"start":{"line":13,"column":70,"offset":316},"end":{"line":14,"column":11,"offset":328}}},{"type":"element","tagName":"a","properties":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy"},"children":[{"type":"text","value":"Referrer-Policy spec","position":{"start":{"line":14,"column":12,"offset":329},"end":{"line":14,"column":32,"offset":349}}}],"position":{"start":{"line":14,"column":11,"offset":328},"end":{"line":14,"column":36,"offset":353}}},{"type":"text","value":" for more details on the\\nmeaning of these values.","position":{"start":{"line":14,"column":36,"offset":353},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":11,"column":1,"offset":138},"end":{"line":15,"column":27,"offset":404}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":102},"end":{"line":15,"column":27,"offset":404}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":18,"column":1,"offset":485}}}'})," - The referrer that will be\npassed to the new window. May or may not result in the ",(0,i.jsx)(t.code,{children:"Referer"})," header being\nsent, depending on the referrer policy."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"postBody"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/post-body",title:"PostBody",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"PostBody Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"data","position":{"start":{"line":10,"column":3,"offset":105},"end":{"line":10,"column":9,"offset":111}}}],"position":{"start":{"line":10,"column":3,"offset":105},"end":{"line":10,"column":9,"offset":111}}},{"type":"text","value":" (","position":{"start":{"line":10,"column":9,"offset":111},"end":{"line":10,"column":11,"offset":113}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/upload-raw-data"},"children":[{"type":"text","value":"UploadRawData"}]},{"type":"text","value":" | ","position":{"start":{"line":10,"column":46,"offset":148},"end":{"line":10,"column":49,"offset":151}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/api/structures/upload-file"},"children":[{"type":"text","value":"UploadFile"}]},{"type":"text","value":")[] - The post data to be sent to the\\nnew window.","position":{"start":{"line":10,"column":77,"offset":179},"end":{"line":11,"column":14,"offset":230}}}],"position":{"start":{"line":10,"column":1,"offset":103},"end":{"line":11,"column":14,"offset":230}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contentType","position":{"start":{"line":12,"column":3,"offset":233},"end":{"line":12,"column":16,"offset":246}}}],"position":{"start":{"line":12,"column":3,"offset":233},"end":{"line":12,"column":16,"offset":246}}},{"type":"text","value":" string - The ","position":{"start":{"line":12,"column":16,"offset":246},"end":{"line":12,"column":30,"offset":260}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"content-type","position":{"start":{"line":12,"column":30,"offset":260},"end":{"line":12,"column":44,"offset":274}}}],"position":{"start":{"line":12,"column":30,"offset":260},"end":{"line":12,"column":44,"offset":274}}},{"type":"text","value":" header used for the data. One of\\n","position":{"start":{"line":12,"column":44,"offset":274},"end":{"line":13,"column":1,"offset":308}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"application/x-www-form-urlencoded","position":{"start":{"line":13,"column":3,"offset":310},"end":{"line":13,"column":38,"offset":345}}}],"position":{"start":{"line":13,"column":3,"offset":310},"end":{"line":13,"column":38,"offset":345}}},{"type":"text","value":" or ","position":{"start":{"line":13,"column":38,"offset":345},"end":{"line":13,"column":42,"offset":349}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"multipart/form-data","position":{"start":{"line":13,"column":42,"offset":349},"end":{"line":13,"column":63,"offset":370}}}],"position":{"start":{"line":13,"column":42,"offset":349},"end":{"line":13,"column":63,"offset":370}}},{"type":"text","value":". Corresponds to\\nthe ","position":{"start":{"line":13,"column":63,"offset":370},"end":{"line":14,"column":7,"offset":393}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"enctype","position":{"start":{"line":14,"column":7,"offset":393},"end":{"line":14,"column":16,"offset":402}}}],"position":{"start":{"line":14,"column":7,"offset":393},"end":{"line":14,"column":16,"offset":402}}},{"type":"text","value":" attribute of the submitted HTML form.","position":{"start":{"line":14,"column":16,"offset":402},"end":{"line":14,"column":54,"offset":440}}}],"position":{"start":{"line":12,"column":1,"offset":231},"end":{"line":14,"column":54,"offset":440}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"boundary","position":{"start":{"line":15,"column":3,"offset":443},"end":{"line":15,"column":13,"offset":453}}}],"position":{"start":{"line":15,"column":3,"offset":443},"end":{"line":15,"column":13,"offset":453}}},{"type":"text","value":" string (optional) - The boundary used to separate multiple parts of\\nthe message. Only valid when ","position":{"start":{"line":15,"column":13,"offset":453},"end":{"line":16,"column":32,"offset":553}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contentType","position":{"start":{"line":16,"column":32,"offset":553},"end":{"line":16,"column":45,"offset":566}}}],"position":{"start":{"line":16,"column":32,"offset":553},"end":{"line":16,"column":45,"offset":566}}},{"type":"text","value":" is ","position":{"start":{"line":16,"column":45,"offset":566},"end":{"line":16,"column":49,"offset":570}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"multipart/form-data","position":{"start":{"line":16,"column":49,"offset":570},"end":{"line":16,"column":70,"offset":591}}}],"position":{"start":{"line":16,"column":49,"offset":570},"end":{"line":16,"column":70,"offset":591}}},{"type":"text","value":".","position":{"start":{"line":16,"column":70,"offset":591},"end":{"line":16,"column":71,"offset":592}}}],"position":{"start":{"line":15,"column":1,"offset":441},"end":{"line":16,"column":71,"offset":592}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":103},"end":{"line":16,"column":71,"offset":592}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":17,"column":1,"offset":593}}}'})," (optional) - The post data that\nwill be sent to the new window, along with the appropriate headers that will\nbe set. If no post data is to be sent, the value will be ",(0,i.jsx)(t.code,{children:"null"}),". Only defined\nwhen the window is being created by a form that set ",(0,i.jsx)(t.code,{children:"target=_blank"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WindowOpenHandlerResponse"})," - When set to ",(0,i.jsx)(t.code,{children:"{ action: 'deny' }"})," cancels the creation of the new\nwindow. ",(0,i.jsx)(t.code,{children:"{ action: 'allow' }"})," will allow the new window to be created.\nReturning an unrecognized value such as a null, undefined, or an object\nwithout a recognized 'action' value will result in a console error and have\nthe same effect as returning ",(0,i.jsx)(t.code,{children:"{action: 'deny'}"}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Called before creating a window when a new window is requested by the renderer, e.g.\nby ",(0,i.jsx)(t.code,{children:"window.open()"}

1),", a link with ",(0,i.jsx)(t.code,{children:'target="_blank"'}),", shift+clicking on a link, or\nsubmitting a form with ",(0,i.jsx)(t.code,{children:'<form target="_blank">'}),". See\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/window-open",children:(0,i.jsx)(t.code,{children:"window.open()"})})," for more details and how to use this in\nconjunction with ",(0,i.jsx)(t.code,{children:"did-create-window"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["An example showing how to customize the process of new ",(0,i.jsx)(t.code,{children:"BrowserWindow"})," creation to be ",(0,i.jsx)(t.code,{children:"BrowserView"})," attached to main window instead:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserView, BrowserWindow } = require('electron')\n\nconst mainWindow = new BrowserWindow()\n\nmainWindow.webContents.setWindowOpenHandler((details) => {\n  return {\n    action: 'allow',\n    createWindow: (options) => {\n      const browserView = new BrowserView(options)\n      mainWindow.addBrowserView(browserView)\n      browserView.setBounds({ x: 0, y: 0, width: 640, height: 480 })\n      // For `background-tab` disposition (e.g., when middle-clicking or ctrl/cmd-clicking a link),\n      // `options.webContents` is undefined because its creation can be deferred. So load the URL manually.\n      if (details.disposition === 'background-tab') {\n        browserView.webContents.loadURL(details.url)\n      }\n      return browserView.webContents\n    }\n  }\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentssetaudiomutedmuted",children:(0,i.jsx)(t.code,{children:"contents.setAudioMuted(muted)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"muted"})," boolean"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Mute the audio on the current web page."}),"\n",(0,i.jsx)(t.h4,{id:"contentsisaudiomuted",children:(0,i.jsx)(t.code,{children:"contents.isAudioMuted()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether this page has been muted."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsiscurrentlyaudible",children:(0,i.jsx)(t.code,{children:"contents.isCurrentlyAudible()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether audio is currently playing."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetcaretbrowsingenabledenabled",children:(0,i.jsx)(t.code,{children:"contents.setCaretBrowsingEnabled(enabled)"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"added":[{"pr-url":"https://github.com/electron/electron/pull/52696"}]}',prReleaseVersionsJson:'{"52696":{"release":null,"backports":["44.0.0","43.6.0"]}}'}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"enabled"})," boolean"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Sets whether ",(0,i.jsx)(t.a,{href:"#contentscaretbrowsingenabled",children:"caret browsing"})," is enabled on the current web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsiscaretbrowsingenabled",children:(0,i.jsx)(t.code,{children:"contents.isCaretBrowsingEnabled()"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"added":[{"pr-url":"https://github.com/electron/electron/pull/52696"}]}',prReleaseVersionsJson:'{"52696":{"release":null,"backports":["44.0.0","43.6.0"]}}'}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether ",(0,i.jsx)(t.a,{href:"#contentscaretbrowsingenabled",children:"caret browsing"})," is enabled for this page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetzoomfactorfactor",children:(0,i.jsx)(t.code,{children:"contents.setZoomFactor(factor)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"factor"})," Double - Zoom factor; default is 1.0."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Changes the zoom factor to the specified factor. Zoom factor is\nzoom percent divided by 100, so 300% = 3.0."}),"\n",(0,i.jsx)(t.p,{children:"The factor must be greater than 0.0."}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetzoomfactor",children:(0,i.jsx)(t.code,{children:"contents.getZoomFactor()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"number"})," - the current zoom factor."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetzoomlevellevel",children:(0,i.jsx)(t.code,{children:"contents.setZoomLevel(level)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"level"})," number - Zoom level."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Changes the zoom level to the specified level. The original size is 0 and each\nincrement above or below represents zooming 20% larger or smaller to default\nlimits of 300% and 50% of original size, respectively. The formula for this is\n",(0,i.jsx)(t.code,{children:"scale := 1.2 ^ level"}),"."]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["The zoom policy at the Chromium level is same-origin by default, meaning that\nthe zoom level for a specific domain propagates across all instances of windows\nwith the same domain. To use per-webContents zoom instead, set the zoom mode to\n",(0,i.jsx)(t.code,{children:"'isolated'"})," via ",(0,i.jsx)(t.a,{href:"#contentssetzoommodemode",children:(0,i.jsx)(t.code,{children:"contents.setZoomMode('isolated')"})}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetzoomlevel",children:(0,i.jsx)(t.code,{children:"contents.getZoomLevel()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"number"})," - the current zoom level."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetzoommodemode",children:(0,i.jsx)(t.code,{children:"contents.setZoomMode(mode)"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"added":[{"pr-url":"https://github.com/electron/electron/pull/49962"}]}',prReleaseVersionsJson:'{"49962":{"release":"44.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"mode"})," string - Can be ",(0,i.jsx)(t.code,{children:"default"}),", ",(0,i.jsx)(t.code,{children:"isolated"}),", ",(0,i.jsx)(t.code,{children:"manual"}),", or ",(0,i.jsx)(t.code,{children:"disabled"}),"."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Sets the zoom mode for this web contents."}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"default"})," - Zoom changes are handled automatically on a per-origin basis.\nOther webContents navigated to the same origin will share the same zoom level."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"isolated"})," - Zoom changes are handled automatically but on a per-webContents basis.\nThis webContents will not be affected by zoom changes in other webContents, and vice versa."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"manual"})," - Automatic zoom handling is disabled. The ",(0,i.jsx)(t.code,{children:"zoom-changed"})," event\nwill still be dispatched, but the page will not actually be zoomed.\nThe zoom level can be managed manually by the application."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"disabled"})," - All zooming in this webContents is disabled. The webContents will revert\nto the default zoom level and all zoom changes will be ignored."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"isolated"})," and ",(0,i.jsx)(t.code,{children:"manual"})," zoom modes persist across navigations."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetzoommode",children:(0,i.jsx)(t.code,{children:"contents.getZoomMode()"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"added":[{"pr-url":"https://github.com/electron/electron/pull/49962"}]}',prReleaseVersionsJson:'{"49962":{"release":"44.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - The current zoom mode. Can be ",(0,i.jsx)(t.code,{children:"default"}),", ",(0,i.jsx)(t.code,{children:"isolated"}),",\n",(0,i.jsx)(t.code,{children:"manual"}),", or ",(0,i.jsx)(t.code,{children:"disabled"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetvisualzoomlevellimitsminimumlevel-maximumlevel",children:(0,i.jsx)(t.code,{children:"contents.setVisualZoomLevelLimits(minimumLevel, maximumLevel)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"minimumLevel"})," number"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"maximumLevel"})," number"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})]}),"\n",(0,i.jsx)(t.p,{children:"Sets the maximum and minimum pinch-to-zoom level."}),"\n",(0,i.jsxs)(t.admonition,{type:"note",children:[(0,i.jsx)(t.p,{children:"Visual zoom is disabled by default in Electron. To re-enable it, call:"}),(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\nwin.webContents.setVisualZoomLevelLimits(1, 3)\n"})})]}),"\n",(0,i.jsx)(t.h4,{id:"contentsundo",children:(0,i.jsx)(t.code,{children:"contents.undo()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"und

1o"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsredo",children:(0,i.jsx)(t.code,{children:"contents.redo()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"redo"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentscut",children:(0,i.jsx)(t.code,{children:"contents.cut()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"cut"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentscopy",children:(0,i.jsx)(t.code,{children:"contents.copy()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"copy"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentscenterselection",children:(0,i.jsx)(t.code,{children:"contents.centerSelection()"})}),"\n",(0,i.jsx)(t.p,{children:"Centers the current text selection in web page."}),"\n",(0,i.jsx)(t.h4,{id:"contentscopyimageatx-y",children:(0,i.jsx)(t.code,{children:"contents.copyImageAt(x, y)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"x"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"y"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Copy the image at the given position to the clipboard."}),"\n",(0,i.jsx)(t.h4,{id:"contentscopyvideoframeatx-y",children:(0,i.jsx)(t.code,{children:"contents.copyVideoFrameAt(x, y)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"x"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"y"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"When executed on a video media element, copies the frame at (x, y) to the clipboard."}),"\n",(0,i.jsx)(t.h4,{id:"contentssavevideoframeasx-y",children:(0,i.jsx)(t.code,{children:"contents.saveVideoFrameAs(x, y)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"x"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"y"})," Integer"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"When executed on a video media element, shows a save dialog and saves the frame at (x, y) to disk."}),"\n",(0,i.jsx)(t.h4,{id:"contentspaste",children:(0,i.jsx)(t.code,{children:"contents.paste()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"paste"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentspasteandmatchstyle",children:(0,i.jsx)(t.code,{children:"contents.pasteAndMatchStyle()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"pasteAndMatchStyle"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsdelete",children:(0,i.jsx)(t.code,{children:"contents.delete()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"delete"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsselectall",children:(0,i.jsx)(t.code,{children:"contents.selectAll()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"selectAll"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsunselect",children:(0,i.jsx)(t.code,{children:"contents.unselect()"})}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"unselect"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsscrolltotop",children:(0,i.jsx)(t.code,{children:"contents.scrollToTop()"})}),"\n",(0,i.jsxs)(t.p,{children:["Scrolls to the top of the current ",(0,i.jsx)(t.code,{children:"webContents"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsscrolltobottom",children:(0,i.jsx)(t.code,{children:"contents.scrollToBottom()"})}),"\n",(0,i.jsxs)(t.p,{children:["Scrolls to the bottom of the current ",(0,i.jsx)(t.code,{children:"webContents"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsadjustselectionoptions",children:(0,i.jsx)(t.code,{children:"contents.adjustSelection(options)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"start"})," Number (optional) - Amount to shift the start index of the current selection."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"end"})," Number (optional) - Amount to shift the end index of the current selection."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Adjusts the current text selection starting and ending points in the focused frame by the given amounts. A negative amount moves the selection towards the beginning of the document, and a positive amount moves the selection towards the end of the document."}),"\n",(0,i.jsx)(t.p,{children:"Example:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\n\n// Adjusts the beginning of the selection 1 letter forward,\n// and the end of the selection 5 letters forward.\nwin.webContents.adju

1stSelection({ start: 1, end: 5 })\n\n// Adjusts the beginning of the selection 2 letters forward,\n// and the end of the selection 3 letters backward.\nwin.webContents.adjustSelection({ start: 2, end: -3 })\n"})}),"\n",(0,i.jsxs)(t.p,{children:["For a call of ",(0,i.jsx)(t.code,{children:"win.webContents.adjustSelection({ start: 1, end: 5 })"})]}),"\n",(0,i.jsx)(t.p,{children:"Before:"}),"\n",(0,i.jsx)("img",{width:"487",alt:"Image Before Text Selection Adjustment",src:"../images/web-contents-text-selection-before.png"}),"\n",(0,i.jsx)(t.p,{children:"After:"}),"\n",(0,i.jsx)("img",{width:"487",alt:"Image After Text Selection Adjustment",src:"../images/web-contents-text-selection-after.png"}),"\n",(0,i.jsx)(t.h4,{id:"contentsreplacetext",children:(0,i.jsx)(t.code,{children:"contents.replace(text)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"text"})," string"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"replace"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsreplacemisspellingtext",children:(0,i.jsx)(t.code,{children:"contents.replaceMisspelling(text)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"text"})," string"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Executes the editing command ",(0,i.jsx)(t.code,{children:"replaceMisspelling"})," in web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsinserttexttext",children:(0,i.jsx)(t.code,{children:"contents.insertText(text)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"text"})," string"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})]}),"\n",(0,i.jsxs)(t.p,{children:["Inserts ",(0,i.jsx)(t.code,{children:"text"})," to the focused element."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsfindinpagetext-options",children:(0,i.jsx)(t.code,{children:"contents.findInPage(text[, options])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"text"})," string - Content to be searched, must not be empty."]}),"\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"forward"})," boolean (optional) - Whether to search forward or backward, defaults to ",(0,i.jsx)(t.code,{children:"true"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"findNext"})," boolean (optional) - Whether to begin a new text finding session with this request. Should be ",(0,i.jsx)(t.code,{children:"true"})," for initial requests, and ",(0,i.jsx)(t.code,{children:"false"})," for follow-up requests. Defaults to ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"matchCase"})," boolean (optional) - Whether search should be case-sensitive,\ndefaults to ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Integer"})," - The request id used for the request."]}),"\n",(0,i.jsxs)(t.p,{children:["Starts a request to find all matches for the ",(0,i.jsx)(t.code,{children:"text"})," in the web page. The result of the request\ncan be obtained by subscribing to ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents#event-found-in-page",children:(0,i.jsx)(t.code,{children:"found-in-page"})})," event."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsstopfindinpageaction",children:(0,i.jsx)(t.code,{children:"contents.stopFindInPage(action)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"action"})," string - Specifies the action to take place when ending\n",(0,i.jsx)(t.a,{href:"#contentsfindinpagetext-options",children:(0,i.jsx)(t.code,{children:"webContents.findInPage"})})," request.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"clearSelection"})," - Clear the selection."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"keepSelection"})," - Translate the selection into a normal selection."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"activateSelection"})," - Focus and click the selection node."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Stops any ",(0,i.jsx)(t.code,{children:"findInPage"})," request for the ",(0,i.jsx)(t.code,{children:"webContents"})," with the provided ",(0,i.jsx)(t.code,{children:"action"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\nwin.webContents.on('found-in-page', (event, result) => {\n  if (result.finalUpdate) win.webContents.stopFindInPage('clearSelection')\n})\n\nconst requestId = win.webContents.findInPage('api')\nconsole.log(requestId)\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentscapturepagerect-opts",children:(0,i.jsx)(t.code,{children:"contents.capturePage([rect, opts])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"rect"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/rectangle",title:"Rectangle",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Rectangle Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}}],"position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}},{"type":"text","value":" number - The x coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":10,"column":6,"offset":110},"end":{"line":10,"column":85,"offset":189}}}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":10,"column":85,"offset":189}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}}],"position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}},{"type":"text","value":" number - The y coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":11,"column":6,"offset":195},"end":{"line":11,"column":85,"offset":274}}}],"position":{"start":{"line":11,"column":1,"offset":190},"end":{"line":11,"column":85,"offset":274}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}}],"position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}},{"type":"text","value":" number - The width of the rectangle (must be an integer).","position":{"start":{"line":12,"column":10,"offset":284},"end":{"line":12,"column":68,"offset":342}}}],"position":{"start":{"line":12,"column":1,"offset":275},"end":{"line":12,"column":68,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}}],"position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}},{"type":"text","value":" number - The height of the rectangle (must be an integer).","position":{"start":{"line":13,"column":11,"offset":353},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":13,"column":1,"offset":343},"end":{"line":13,"column":70,"offset":412}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":14,"column":1,"offset":413}}}'})," (optional) - The area of the page to be captured."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"opts"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"stayHidden"})," boolean (optional) -  Keep the page hidden instead of visible. Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"stayAwake"})," boolean (optional) -  Keep the system awake instead of allowing it to sleep. Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<NativeImage>"})," - Resolves with a ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:"NativeImage"})]}),"\n",(0,i.jsxs)(t.p,{children:["Captures a snapshot of the page within ",(0,i.jsx)(t.code,{children:"rect"}),". Omitting ",(0,i.jsx)(t.code,{children:"rect"})," will capture the whole visible page.\nThe page is considered visible when its browser window is hidden and the capturer count is non-zero.\nIf you would like the page to stay hidden, you should ensure that ",(0,i.jsx)(t.code,{children:"stayHidden"})," is set to true."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsisbeingcaptured",children:(0,i.jsx)(t.code,{children:"contents.isBeingCaptured()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether this page is being captured. It returns true when the capturer count\nis greater than 0."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetprintersasync",children:(0,i.jsx)(t.code,{children:"contents.getPrintersAsync()"})}),"\n",(0,i.jsx)(t.p,{children:"Get the system printer list."}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<PrinterInfo[]>"})," - Resolves with a ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/printer-info",title:"PrinterInfo[]",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"PrinterInfo Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"name","position":{"start":{"line":10,"column":3,"offset":114},"end":{"line":10,"column":9,"offset":120}}}],"position":{"start":{"line":10,"column":3,"offset":114},"end":{"line":10,"column":9,"offset":120}}},{"type":"text","value":" string - the name of the printer as understood by the OS.","position":{"start":{"line":10,"column":9,"offset":120},"end":{"line":10,"column":67,"offset":178}}}],"position":{"start":{"line":10,"column":1,"offset":112},"end":{"line":10,"column":67,"offset":178}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"displayName","position":{"start":{"line":11,"column":3,"offset":181},"end":{"line":11,"column":16,"offset":194}}

1}],"position":{"start":{"line":11,"column":3,"offset":181},"end":{"line":11,"column":16,"offset":194}}},{"type":"text","value":" string - the name of the printer as shown in Print Preview.","position":{"start":{"line":11,"column":16,"offset":194},"end":{"line":11,"column":76,"offset":254}}}],"position":{"start":{"line":11,"column":1,"offset":179},"end":{"line":11,"column":76,"offset":254}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"description","position":{"start":{"line":12,"column":3,"offset":257},"end":{"line":12,"column":16,"offset":270}}}],"position":{"start":{"line":12,"column":3,"offset":257},"end":{"line":12,"column":16,"offset":270}}},{"type":"text","value":" string - a longer description of the printer\'s type.","position":{"start":{"line":12,"column":16,"offset":270},"end":{"line":12,"column":69,"offset":323}}}],"position":{"start":{"line":12,"column":1,"offset":255},"end":{"line":12,"column":69,"offset":323}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{"className":[]},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"options","position":{"start":{"line":13,"column":3,"offset":326},"end":{"line":13,"column":12,"offset":335}}}],"position":{"start":{"line":13,"column":3,"offset":326},"end":{"line":13,"column":12,"offset":335}}}

1,{"type":"text","value":" Object - an object containing a variable number of platform-specific printer information.","position":{"start":{"line":13,"column":12,"offset":335},"end":{"line":13,"column":102,"offset":425}}}],"position":{"start":{"line":13,"column":1,"offset":324},"end":{"line":13,"column":102,"offset":425}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":112},"end":{"line":13,"column":102,"offset":425}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The number represented by ","position":{"start":{"line":15,"column":1,"offset":427},"end":{"line":15,"column":27,"offset":453}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"status","position":{"start":{"line":15,"column":27,"offset":453},"end":{"line":15,"column":35,"offset":461}}}],"position":{"start":{"line":15,"column":27,"offset":453},"end":{"line":15,"column":35,"offset":461}}},{"type":"text","value":" means different things on different platforms: on Windows its potential values can be found ","position":{"start":{"line":15,"column":35,"offset":461},"end":{"line":15,"column":128,"offset":554}}},{"type":"element","tagName":"a","properties":{"href":"https://learn.microsoft.com/en-us/windows/win32/printdocs/printer-info-2"},"children":[{"type":"text","value":"here","position":{"start":{"line":15,"column":129,"offset":555},"end":{"line":15,"column":133,"offset":559}}}],"position":{"start":{"line":15,"column":128,"offset":554},"end":{"line":15,"column":208,"offset":634}}},{"type":"text","value":", and on Linux and macOS they can be found ","position":{"start":{"line":15,"column":208,"offset":634},"end":{"line":15,"column":251,"offset":677}}},{"type":"element","tagName":"a","properties":{"href":"https://www.cups.org/doc/cupspm.html"},"children":[{"type":"text","value":"here","position":{"start":{"line":15,"column":252,"offset":678},"end":{"line":15,"column":256,"offset":682}}}],"position":{"start":{"line":15,"column":251,"offset":677},"end":{"line":15,"column":295,"offset":721}}},{"type":"text","value":".","position":{"start":{"line":15,"column":295,"offset":721},"end":{"line":15,"column":296,"offset":722}}}],"position":{"start":{"line":15,"column":1,"offset":427},"end":{"line":15,"column":296,"offset":722}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":53,"column":1,"offset":2088}}}'})]}),"\n",(0,i.jsx)(t.h4,{id:"contentsprintoptions-callback",children:(0,i.jsx)(t.code,{children:"contents.print([options], [callback])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"silent"})," boolean (optional) - Don't ask user for print settings. Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"printBackground"})," boolean (optional) - Prints the background color and image of\nthe web page. Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"deviceName"})," string (optional) - Set the printer device name to use. Must be the system-defined name and not the 'friendly' name, e.g 'Brother_QL_820NWB' and not 'Brother QL-820NWB'."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"color"})," boolean (optional) - Set whether the printed web page will be in color or grayscale. Default is ",(0,i.jsx)(t.code,{children:"true"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"margins"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"marginType"})," string (optional) - Can be ",(0,i.jsx)(t.code,{children:"default"}),", ",(0,i.jsx)(t.code,{children:"none"}),", ",(0,i.jsx)(t.code,{children:"printableArea"}),", or ",(0,i.jsx)(t.code,{children:"custom"}),". If ",(0,i.jsx)(t.code,{children:"custom"})," is chosen, you will also need to specify ",(0,i.jsx)(t.code,{children:"top"}),", ",(0,i.jsx)(t.code,{children:"bottom"}),", ",(0,i.jsx)(t.code,{children:"left"}),", and ",(0,i.jsx)(t.code,{children:"right"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"top"})," number (optional) - The top margin of the printed web page, in pixels."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"bottom"})," number (optional) - The bottom margin of the printed web page, in pixels."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"left"})," number (optional) - The left margin of the printed web page, in pixels."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"right"})," number (optional) - The right margin of the printed web page, in pixels."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"landscape"})," boolean (optional) - Whether the web page should be printed in landscape mode. Default is ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scaleFactor"})," number (optional) - The scale factor of the web page."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pagesPerSheet"})," number (optional) - The number of pages to print per page sheet."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"collate"})," boolean (optional) - Whether the web page should be collated."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"copies"})," number (optional) - The number of copies of the web page to print."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pageRanges"})," Object[]  (optional) - The page range to print. On macOS, only one range is honored.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"from"})," number - Index of the first page to print (0-based)."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"to"})," number - Index of the last page to print (inclusive) (0-based)."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"duplexMode"})," string (optional) - Set the duplex mode of the printed web page. Can be ",(0,i.jsx)(t.code,{children:"simplex"}),", ",(0,i.jsx)(t.code,{children:"shortEdge"}),", or ",(0,i.jsx)(t.code,{children:"longEdge"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"dpi"})," Record<string, number> (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"horizontal"})," number (optional) - The horizontal dpi."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"vertical"})," number (optional) - The vertical dpi."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"header"})," string (optional) - string to be printed as page header."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"footer"})," string (optional) - string to be printed as page footer."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pageSize"})," string | Size (optional) - Specify page size of the printed document. Can be ",(0,i.jsx)(t.code,{children:"A0"}),", ",(0,i.jsx)(t.code,{children:"A1"}),", ",(0,i.jsx)(t.code,{children:"A2"}),", ",(0,i.jsx)(t.code,{children:"A3"}),",\n",(0,i.jsx)(t.code,{children:"A4"}),", ",(0,i.jsx)(t.code,{children:"A5"}),", ",(0,i.jsx)(t.code,{children:"A6"}),", ",(0,i.jsx)(t.code,{children:"Legal"}),", ",(0,i.jsx)(t.code,{children:"Letter"}),", ",(0,i.jsx)(t.code,{children:"Tabloid"})," or an Object containing ",(0,i.jsx)(t.code,{children:"height"})," and ",(0,i.jsx)(t.code,{children:"width"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"usePrinterDefaultPageSize"})," boolean (optional) - Whether to use a given printer's default page size. Default is ",(0,i.jsx)(t.code,{children:"false"}),". Cannot be combined with ",(0,i.jsx)(t.code,{children:"pageSize"}),". When ",(0,i.jsx)(t.code,{children:"deviceName"})," is provided, uses the default page size of that specific printer. When ",(0,i.jsx)(t.code,{children:"deviceName"})," is not provided, uses the default page size of the system's default printer. If the printer's default page size cannot be retrieved, falls back to A4 (210mm x 297mm)."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"callback"})," Function (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"success"})," boolean - Indicates success of the print call."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"failureReason"})," string - Error description called back if the print fails."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["When a custom ",(0,i.jsx)(t.code,{children:"pageSize"})," is passed, Chromium attempts to validate platform specific minimum values for ",(0,i.jsx)(t.code,{children:"width_microns"})," and ",(0,i.jsx)(t.code,{children:"height_microns"}),". Width and height must both be minimum 353 microns but may be higher on some operating systems. If a valid ",(0,i.jsx)(t.code,{children:"pageSize"})," is not passed and ",(0,i.jsx)(t.code,{children:"usePrinterDefaultPageSize"})," is ",(0,i.jsx)(t.code,{children:"false"}),", an error will be thrown."]}),"\n",(0,i.jsxs)(t.p,{children:["Prints window's web page. When ",(0,i.jsx)(t.code,{children:"silent"})," is set to ",(0,i.jsx)(t.code,{children:"true"}),", Electron will pick\nthe system's default printer if ",(0,i.jsx)(t.code,{children:"deviceName"})," is empty and the default settings for printing."]}),"\n",(0,i.jsxs)(t.p,{children:["Some possible ",(0,i.jsx)(t.code,{children:"failureReason"}),"s for print failure include:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:'"Invalid printer settings"'}),"\n",(0,i.jsx)(t.li,{children:'"Print job canceled"'}),"\n",(0,i.jsx)(t.li,{children:'"Print job failed"'}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Use ",(0,i.jsx)(t.code,{children:"page-break-before: always;"})," CSS style to force to print to a new page."]}),"\n",(0,i.jsx)(t.p,{children:"Example usage:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const win = new BrowserWindow()\nconst options = {\n  silent: true,\n  deviceName: 'My-Printer',\n  pageRanges: [\n    {\n      from: 0,\n      to: 1\n    }\n  ]\n}\nwin.webContents.print(options, (success, errorType) => {\n  if (!success) console.log(errorType)\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsprinttopdfoptions",children:(0,i.jsx)(t.code,{children:"contents.printToPDF(options)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/structures/print-to-pdf-options",children:"PrintToPDFOptions"}),(0,i.jsx)(i.Fragment,{children:(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"landscape"})," boolean (optional) - Paper orientation.",(0,i.jsx)(t.code,{children:"true"})," for landscape, ",(0,i.jsx)(t.code,{children:"false"})," for portrait. Defaults to false."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"displayHeaderFooter"})," boolean (optional) - Whether to display header and footer. Defaults to false."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"printBackgroun

1d"})," boolean (optional) - Whether to print background graphics. Defaults to false."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scale"})," number(optional)  - Scale of the webpage rendering. Defaults to 1."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pageSize"})," string | Size (optional) - Specify page size of the generated PDF. Can be ",(0,i.jsx)(t.code,{children:"A0"}),", ",(0,i.jsx)(t.code,{children:"A1"}),", ",(0,i.jsx)(t.code,{children:"A2"}),", ",(0,i.jsx)(t.code,{children:"A3"}),",\n",(0,i.jsx)(t.code,{children:"A4"}),", ",(0,i.jsx)(t.code,{children:"A5"}),", ",(0,i.jsx)(t.code,{children:"A6"}),", ",(0,i.jsx)(t.code,{children:"Legal"}),", ",(0,i.jsx)(t.code,{children:"Letter"}),", ",(0,i.jsx)(t.code,{children:"Tabloid"}),", ",(0,i.jsx)(t.code,{children:"Ledger"}),", or an Object containing ",(0,i.jsx)(t.code,{children:"height"})," and ",(0,i.jsx)(t.code,{children:"width"})," in inches. Defaults to ",(0,i.jsx)(t.code,{children:"Letter"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"margins"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/structures/print-to-pdf-margins",children:"PrintToPDFMargins"})," (optional)",(0,i.jsx)(i.Fragment,{children:(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"top"})," number (optional) - Top margin in inches. Defaults to 1cm (~0.4 inches)."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"bottom"})," number (optional) - Bottom margin in inches. Defaults to 1cm (~0.4 inches)."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"left"})," number (optional) - Left margin in inches. Defaults to 1cm (~0.4 inches)."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"right"})," number (optional) - Right margin in inches. Defaults to 1cm (~0.4 inches)."]}),"\n"]})})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"pageRanges"})," string (optional) - Page ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"headerTemplate"})," string (optional) - HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: ",(0,i.jsx)(t.code,{children:"date"})," (formatted print date), ",(0,i.jsx)(t.code,{children:"title"})," (document title), ",(0,i.jsx)(t.code,{children:"url"})," (document location), ",(0,i.jsx)(t.code,{children:"pageNumber"})," (current page number) and ",(0,i.jsx)(t.code,{children:"totalPages"})," (total pages in the document). For example, ",(0,i.jsx)(t.code,{children:"<span class=title></span>"})," would generate span containing the title."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"footerTemplate"})," string (optional) - HTML template for the print footer. Should use the same format as the ",(0,i.jsx)(t.code,{children:"headerTemplate"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"preferCSSPageSize"})," boolean (optional) - Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"generateTaggedPDF"})," boolean (optional) ",(0,i.jsx)(t.em,{className:"badge badge--warning",children:"Experimental"})," - Whether or not to generate a tagged (accessible) PDF. Defaults to false. As this property is experimental, the generated PDF may not adhere fully to PDF/UA and WCAG standards."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"generateDocumentOutline"})," boolean (optional) ",(0,i.jsx)(t.em,{className:"badge badge--warning",children:"Experimental"})," - Whether or not to generate a PDF document outline from content headers. Defaults to false."]}),"\n"]})})]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<Buffer>"})," - Resolves with the generated PDF data."]}),"\n",(0,i.jsx)(t.p,{children:"Prints the window's web page as PDF."}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"landscape"})," will be ignored if ",(0,i.jsx)(t.code,{children:"@page"})," CSS at-rule is used in the web page."]}),"\n",(0,i.jsxs)(t.p,{children:["An example of ",(0,i.jsx)(t.code,{children:"webContents.printToPDF"}),":"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { app, BrowserWindow } = require('electron')\n\nconst fs = require('node:fs')\nconst os = require('node:os')\nconst path = require('node:path')\n\napp.whenReady().then(() =>

1 {\n  const win = new BrowserWindow()\n  win.loadURL('https://github.com')\n\n  win.webContents.on('did-finish-load', () => {\n    // Use default printing options\n    const pdfPath = path.join(os.homedir(), 'Desktop', 'temp.pdf')\n    win.webContents\n      .printToPDF({})\n      .then((data) => {\n        fs.writeFile(pdfPath, data, (error) => {\n          if (error) throw error\n          console.log(`Wrote PDF successfully to ${pdfPath}`)\n        })\n      })\n      .catch((error) => {\n        console.log(`Failed to write PDF to ${pdfPath}: `, error)\n      })\n  })\n})\n"})}),"\n",(0,i.jsxs)(t.p,{children:["See ",(0,i.jsx)(t.a,{href:"https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF",children:"Page.printToPdf"})," for more information."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsaddworkspacepath",children:(0,i.jsx)(t.code,{children:"contents.addWorkSpace(path)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"path"})," string"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Adds the specified path to DevTools workspace. Must be used after DevTools\ncreation:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow()\nwin.webContents.on('devtools-opened', () => {\n  win.webContents.addWorkSpace(__dirname)\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsremoveworkspacepath",children:(0,i.jsx)(t.code,{children:"contents.removeWorkSpace(path)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"path"})," string"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Removes the specified path from DevTools workspace."}),"\n",(0,i.jsx)(t.h4,{id:"contentssetdevtoolswebcontentsdevtoolswebcontents",children:(0,i.jsx)(t.code,{children:"contents.setDevToolsWebContents(devToolsWebContents)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"devToolsWebContents"})," WebContents"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Uses the ",(0,i.jsx)(t.code,{children:"devToolsWebContents"})," as the target ",(0,i.jsx)(t.code,{children:"WebContents"})," to show DevTools."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"devToolsWebContents"})," must not have done any navigation, and it should not\nbe used for other purposes after the call."]}),"\n",(0,i.jsxs)(t.p,{children:["By default, Electron manages the DevTools by creating an internal ",(0,i.jsx)(t.code,{children:"WebContents"}),"\nwith native view, which developers have very limited control of. With the\n",(0,i.jsx)(t.code,{children:"setDevToolsWebContents"})," method, developers can use any ",(0,i.jsx)(t.code,{children:"WebContents"})," to show\nthe DevTools in it, such as ",(0,i.jsx)(t.a,{href:"/docs/latest/api/browser-window",children:(0,i.jsx)(t.code,{children:"BrowserWindow"})})," or ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents-view",children:(0,i.jsx)(t.code,{children:"WebContentsView"})}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["Note that closing the DevTools does not destroy the ",(0,i.jsx)(t.code,{children:"devToolsWebContents"}),", it\nis the caller's responsibility to destroy ",(0,i.jsx)(t.code,{children:"devToolsWebContents"})," manually."]}),"\n",(0,i.jsxs)(t.p,{children:["An example of showing DevTools in a ",(0,i.jsx)(t.code,{children:"BrowserWindow"}),":"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",metastring:"title='main.js'",children:"const { app, BrowserWindow } = require('electron')\n\nlet win = null\nlet devtools = null\n\napp.whenReady().then(() => {\n  win = new BrowserWindow()\n  devtools = new BrowserWindow()\n  win.loadURL('https://github.com')\n  win.webContents.setDevToolsWebContents(devtools.webContents)\n  win.webContents.openDevTools({ mode: 'detach' })\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsopendevtoolsoptions",children:(0,i.jsx)(t.code,{children:"contents.openDevTools([options])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{className:"electron-api-options-list",children:[(0,i.jsx)(t.code,{children:"options"})," Object (optional)","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"mode"})," string - Opens the DevTools with specified dock state, can be\n",(0,i.jsx)(t.code,{children:"left"}),", ",(0,i.jsx)(t.code,{children:"right"}),", ",(0,i.jsx)(t.code,{children:"bottom"}

1),", ",(0,i.jsx)(t.code,{children:"undocked"}),", ",(0,i.jsx)(t.code,{children:"detach"}),". Defaults to last used dock state.\nIn ",(0,i.jsx)(t.code,{children:"undocked"})," mode it's possible to dock back. In ",(0,i.jsx)(t.code,{children:"detach"})," mode it's not."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"activate"})," boolean (optional) - Whether to bring the opened DevTools window\nto the foreground. The default is ",(0,i.jsx)(t.code,{children:"true"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"title"})," string (optional) - A title for the DevTools window (only in ",(0,i.jsx)(t.code,{children:"undocked"})," or ",(0,i.jsx)(t.code,{children:"detach"})," mode)."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Opens the DevTools."}),"\n",(0,i.jsxs)(t.p,{children:["When ",(0,i.jsx)(t.code,{children:"contents"})," is a ",(0,i.jsx)(t.code,{children:"<webview>"})," tag, the ",(0,i.jsx)(t.code,{children:"mode"})," would be ",(0,i.jsx)(t.code,{children:"detach"})," by default,\nexplicitly passing an empty ",(0,i.jsx)(t.code,{children:"mode"})," can force using last used dock state."]}),"\n",(0,i.jsxs)(t.p,{children:["On Windows, if Window Control Overlay is enabled, DevTools will be opened with ",(0,i.jsx)(t.code,{children:"mode: 'detach'"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsclosedevtools",children:(0,i.jsx)(t.code,{children:"contents.closeDevTools()"})}),"\n",(0,i.jsx)(t.p,{children:"Closes the DevTools view."}),"\n",(0,i.jsx)(t.h4,{id:"contentsisdevtoolsopened",children:(0,i.jsx)(t.code,{children:"contents.isDevToolsOpened()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the DevTools view is opened."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsisdevtoolsfocused",children:(0,i.jsx)(t.code,{children:"contents.isDevToolsFocused()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Whether the DevTools view is focused ."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetdevtoolstitle",children:(0,i.jsx)(t.code,{children:"contents.getDevToolsTitle()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - the current title of the DevTools window. This will only be visible\nif DevTools is opened in ",(0,i.jsx)(t.code,{children:"undocked"})," or ",(0,i.jsx)(t.code,{children:"detach"})," mode."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetdevtoolstitletitle",children:(0,i.jsx)(t.code,{children:"contents.setDevToolsTitle(title)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"title"})," string"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Changes the title of the DevTools window to ",(0,i.jsx)(t.code,{children:"title"}),". This will only be visible if DevTools is\nopened in ",(0,i.jsx)(t.code,{children:"undocked"})," or ",(0,i.jsx)(t.code,{children:"detach"})," mode."]}),"\n",(0,i.jsx)(t.h4,{id:"contentstoggledevtools",children:(0,i.jsx)(t.code,{children:"contents.toggleDevTools()"})}),"\n",(0,i.jsx)(t.p,{children:"Toggles the developer tools."}),"\n",(0,i.jsx)(t.h4,{id:"contentsinspectelementx-y",children:(0,i.jsx)(t.code,{children:"contents.inspectElement(x, y)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"x"})," Integer"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"y"})," Integer"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Starts inspecting element at position (",(0,i.jsx)(t.code,{children:"x"}),", ",(0,i.jsx)(t.code,{children:"y"}),")."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsinspectsharedworker",children:(0,i.jsx)(t.code,{children:"contents.inspectSharedWorker()"})}),"\n",(0,i.jsx)(t.p,{children:"Opens the developer tools for the shared worker context."}),"\n",(0,i.jsx)(t.h4,{id:"contentsinspectsharedworkerbyidworkerid",children:(0,i.jsx)(t.code,{children:"contents.inspectSharedWorkerById(workerId)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"workerId"})," string"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Inspects the shared worker based on its ID."}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetallsharedworkers",children:(0,i.jsx)(t.code,{children:"contents.getAllSharedWorkers()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/shared-worker-info",title:"SharedWorkerInfo[]",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"SharedWorkerInfo Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"id","position":{"start":{"line":10,"column":3,"offset":130},"end":{"line":10,"column":7,"offset":134}}}],"position":{"start":{"line":10,"column":3,"offset":130},"end":{"line":10,"column":7,"offset":134}}},{"type":"text","value":" string - The unique id of the shared worker.","position":{"start":{"line":10,"column":7,"offset":134},"end":{"line":10,"column":52,"offset":179}}}],"position":{"start":{"line":10,"column":1,"offset":128},"end":{"line":10,"column":52,"offset":179}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"url","position":{"start":{"line":11,"column":3,"offset":182},"end":{"line":11,"column":8,"offset":187}}}],"position":{"start":{"line":11,"column":3,"offset":182},"end":{"line":11,"column":8,"offset":187}}},{"type":"text","value":" string - The url of the shared worker.","position":{"start":{"line":11,"column":8,"offset":187},"end":{"line":11,"column":47,"offset":226}}}],"position":{"start":{"line":11,"column":1,"offset":180},"end":{"line":11,"column":47,"offset":226}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":128},"end":{"line":11,"column":47,"offset":226}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":227}}}'})," - Information about all Shared Workers."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsinspectserviceworker",children:(0,i.jsx)(t.code,{children:"contents.inspectServiceWorker()"})}),"\n",(0,i.jsx)(t.p,{children:"Opens the developer tools for the service worker context."}),"\n",(0,i.jsx)(t.h4,{id:"contentssendchannel-args",children:(0,i.jsx)(t.code,{children:"contents.send(channel, ...args)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"channel"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"...args"})," any[]"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Send an asynchronous message to the renderer process via ",(0,i.jsx)(t.code,{children:"channel"}),", along with\narguments. Arguments will be serialized with the ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm",children:"Structured Clone Algorithm"}),",\njust like ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage",children:(0,i.jsx)(t.code,{children:"postMessage"})}),", so prototype chains will not be\nincluded. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will\nthrow an exception."]}),"\n",(0,i.jsx)(t.admonition,{type:"warning",children:(0,i.jsx)(t.p,{children:"Sending non-standard JavaScript types such as DOM objects or\nspecial Electron objects will throw an exception."})}),"\n",(0,i.jsxs)(t.p,{children:["For additional reading, refer to ",(0,i.jsx)(t.a,{href:"/docs/latest/tutorial/ipc",children:"Electron's IPC guide"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssendtoframeframeid-channel-args",children:(0,i.jsx)(t.code,{children:"contents.sendToFrame(frameId, channel, ...args)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frameId"})," Integer | [number, number] - the ID of the frame to send to, or a\npair of ",(0,i.jsx)(t.code,{children:"[processId, frameId]"})," if the frame is in a different process to the\nmain frame."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"channel"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"...args"})," any[]"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Send an asynchronous message to a specific frame in a renderer process via\n",(0,i.jsx)(t.code,{children:"channel"}),", along with arguments. Arguments will be serialized with the\n",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm",children:"Structured Clone Algorithm"}),", just like ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage",children:(0,i.jsx)(t.code,{children:"postMessage"})}

1),", so prototype\nchains will not be included. Sending Functions, Promises, Symbols, WeakMaps, or\nWeakSets will throw an exception."]}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NOTE:"})," Sending non-standard JavaScript types such as DOM objects or\nspecial Electron objects will throw an exception."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["The renderer process can handle the message by listening to ",(0,i.jsx)(t.code,{children:"channel"})," with the\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/ipc-renderer",children:(0,i.jsx)(t.code,{children:"ipcRenderer"})})," module."]}),"\n",(0,i.jsxs)(t.p,{children:["If you want to get the ",(0,i.jsx)(t.code,{children:"frameId"})," of a given renderer context you should use\nthe ",(0,i.jsx)(t.code,{children:"webFrame.routingId"})," value.  E.g."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// In a renderer process\nconsole.log('My frameId is:', require('electron').webFrame.routingId)\n"})}),"\n",(0,i.jsxs)(t.p,{children:["You can also read ",(0,i.jsx)(t.code,{children:"frameId"})," from all incoming IPC messages in the main process."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// In the main process\nipcMain.on('ping', (event) => {\n  console.info('Message came from frameId:', event.frameId)\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentspostmessagechannel-message-transfer",children:(0,i.jsx)(t.code,{children:"contents.postMessage(channel, message, [transfer])"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"channel"})," string"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"message"})," any"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"transfer"})," MessagePortMain[] (optional)"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Send a message to the renderer process, optionally transferring ownership of\nzero or more ",(0,i.jsx)(t.a,{href:"/docs/latest/api/message-port-main",children:(0,i.jsx)(t.code,{children:"MessagePortMain"})})," objects."]}),"\n",(0,i.jsxs)(t.p,{children:["The transferred ",(0,i.jsx)(t.code,{children:"MessagePortMain"})," objects will be available in the renderer\nprocess by accessing the ",(0,i.jsx)(t.code,{children:"ports"})," property of the emitted event. When they\narrive in the renderer, they will be native DOM ",(0,i.jsx)(t.code,{children:"MessagePort"})," objects."]}),"\n",(0,i.jsx)(t.p,{children:"For example:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// Main process\nconst win = new BrowserWindow()\nconst { port1, port2 } = new MessageChannelMain()\nwin.webContents.postMessage('port', { message: 'hello' }, [port1])\n\n// Renderer process\nipcRenderer.on('port', (e, msg) => {\n  const [port] = e.ports\n  // ...\n})\n"})}),"\n",(0,i.jsx)(t.h4,{id:"contentsenabledeviceemulationparameters",children:(0,i.jsx)(t.code,{children:"contents.enableDeviceEmulation(parameters)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"parameters"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"screenPosition"})," string - Specify the screen type to emulate\n(default: ",(0,i.jsx)(t.code,{children:"desktop"}),"):","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"desktop"})," - Desktop screen type."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"mobile"})," - Mobile screen type."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"screenSize"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/size",title:"Size",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Size Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}}],"position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}},{"type":"text","value":" number","position":{"start":{"line":10,"column":10,"offset":99},"end":{"line":10,"column":17,"offset":106}}}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":10,"column":17,"offset":106}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}}],"position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}},{"type":"text","value":" number","position":{"start":{"line":11,"column":11,"offset":117},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":11,"column":1,"offset":107},"end":{"line":11,"column":18,"offset":124}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":125}}}'})," - Set the emulated screen size (screenPosition == mobile)."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"viewPosition"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/point",title:"Point",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Point Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":95},"end":{"line":10,"column":6,"offset":98}}}],"position":{"start":{"line":10,"column":3,"offset":95},"end":{"line":10,"column":6,"offset":98}}},{"type":"text","value":" number","position":{"start":{"line":10,"column":6,"offset":98},"end":{"line":10,"column":13,"offset":105}}}],"position":{"start":{"line":10,"column":1,"offset":93},"end":{"line":10,"column":13,"offset":105}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":108},"end":{"line":11,"column":6,"offset":111}}}],"position":{"start":{"line":11,"column":3,"offset":108},"end":{"line":11,"column":6,"offset":111}}},{"type":"text","value":" number","position":{"start":{"line":11,"column":6,"offset":111},"end":{"line":11,"column":13,"offset":118}}}],"position":{"start":{"line":11,"column":1,"offset":106},"end":{"line":11,"column":13,"offset":118}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":93},"end":{"line":11,"column":13,"offset":118}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Both "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":14,"column":8,"offset":137},"end":{"line":14,"column":11,"offset":140}}}],"position":{"start":{"line":14,"column":8,"offset":137},"end":{"line":14,"column":11,"offset":140}}},{"type":"text","value":" and ","position":{"start":{"line":14,"column":11,"offset":140},"end":{"line":14,"column":16,"offset":145}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":14,"column":16,"offset":145},"end":{"line":14,"column":19,"offset":148}}}],"position":{"start":{"line":14,"column":16,"offset":145},"end":{"line":14,"column":19,"offset":148}}},{"type":"text","value":" must be whole integers, when providing a point object\\nas input to an Electron API we will automatically round your ","position":{"start":{"line":14,"column":19,"offset":148},"end":{"line":15,"column":64,"offset":266}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":15,"column":64,"offset":266},"end":{"line":15,"column":67,"offset":269}}}],"position":{"start":{"line":15,"column":64,"offset":266},"end":{"line":15,"column":67,"offset":269}}},{"type":"text","value":" and ","position":{"start":{"line":15,"column":67,"offset":269},"end":{"line":15,"column":72,"offset":274}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":15,"column":72,"offset":274},"end":{"line":15,"column":75,"offset":277}}}],"position":{"start":{"line":15,"column":72,"offset":274},"end":{"line":15,"column":75,"offset":277}}},{"type":"text","value":" values\\nto the nearest whole integer.","position":{"start":{"line":15,"column":75,"offset":277},"end":{"line":16,"column":32,"offset":316}}}]}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":17,"column":1,"offset":317}}}'})," - Position the view on the screen\n(screenPosition == mobile) (default: ",(0,i.jsx)(t.code,{children:"{ x: 0, y: 0 }"}),")."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"deviceScaleFactor"})," Integer - Set the device scale factor (if zero defaults to\noriginal device scale factor) (default: ",(0,i.jsx)(t.code,{children:"0"}),")."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"viewSize"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/size",title:"Size",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Size Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}}],"position":{"start":{"line":10,"column":3,"offset":92},"end":{"line":10,"column":10,"offset":99}}},{"type":"text","value":" number","position":{"start":{"line":10,"column":10,"offset":99},"end":{"line":10,"column":17,"offset":106}}}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":10,"column":17,"offset":106}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}}],"position":{"start":{"line":11,"column":3,"offset":109},"end":{"line":11,"column":11,"offset":117}}},{"type":"text","value":" number","position":{"start":{"line":11,"column":11,"offset":117},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":11,"column":1,"offset":107},"end":{"line":11,"column":18,"offset":124}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":90},"end":{"line":11,"column":18,"offset":124}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":12,"column":1,"offset":125}}}'})," - Set the emulated view size (empty means no override)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scale"})," Float - Scale of emulated view inside available space (not in fit to\nview mode) (default: ",(0,i.jsx)(t.code,{children:"1"}),")."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Enable device emulation with the given parameters."}),"\n",(0,i.jsx)(t.h4,{id:"contentsdisabledeviceemulation",children:(0,i.jsx)(t.code,{children:"contents.disableDeviceEmulation()"})}),"\n",(0,i.jsxs)(t.p,{children:["Disable device emulation enabled by ",(0,i.jsx)(t.code,{children:"webContents.enableDeviceEmulation"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssendinputeventinputevent",children:(0,i.jsx)(t.code,{children:"contents.sendInputEvent(inputEvent)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"inputEvent"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/mouse-input-event",title:"MouseInputEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"MouseInputEvent Object extends InputEvent"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":169},"end":{"line":10,"column":9,"offset":175}}}],"position":{"start":{"line":10,"column":3,"offset":169},"end":{"line":10,"column":9,"offset":175}}},{"type":"text","value":" string - The type of the event, can be ","position":{"start":{"line":10,"column":9,"offset":175},"end":{"line":10,"column":49,"offset":215}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseDown","position":{"start":{"line":10,"column":49,"offset":215},"end":{"line":10,"column":60,"offset":226}}}],"position":{"start":{"line":10,"column":49,"offset":215},"end":{"line":10,"column":60,"offset":226}}},{"type":"text","value":",\\n","position":{"start":{"line":10,"column":60,"offset":226},"end":{"line":11,"column":1,"offset":228}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseUp","position":{"start":{"line":11,"column":5,"offset":232},"end":{"line":11,"column":14,"offset":241}}}],"position":{"start":{"line":11,"column":5,"offset":232},"end":{"line":11,"column":14,"offset":241}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":14,"offset":241},"end":{"line":11,"column":16,"offset":243}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseEnter","position":{"start":{"line":11,"column":16,"offset":243},"end":{"line":11,"column":28,"offset":255}}}],"position":{"start":{"line":11,"column":16,"offset":243},"end":{"line":11,"column":28,"offset":255}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":28,"offset":255},"end":{"line":11,"column":30,"offset":257}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseLeave","position":{"start":{"line":11,"column":30,"offset":257},"end":{"line":11,"column":42,"offset":269}}}],"position":{"start":{"line":11,"column":30,"offset":257},"end":{"line":11,"column":42,"offset":269}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":42,"offset":269},"end":{"line":11,"column":44,"offset":271}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"contextMenu","position":{"start":{"line":11,"column":44,"offset":271},"end":{"line":11,"column":57,"offset":284}}}],"position":{"start":{"line":11,"column":44,"offset":271},"end":{"line":11,"column":57,"offset":284}}},{"type":"text","value":", ","position":{"start":{"line":11,"column":57,"offset":284},"end":{"line":11,"column":59,"offset":286}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseWheel","position":{"start":{"line":11,"column":59,"offset":286},"end":{"line":11,"column":71,"offset":298}}}],"position":{"start":{"line":11,"column":59,"offset":286},"end":{"line":11,"column":71,"offset":298}}},{"type":"text","value":" or ","position":{"start":{"line":11,"column":71,"offset":298},"end":{"line":11,"column":75,"offset":302}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseMove","position":{"start":{"line":11,"column":75,"offset":302},"end":{"line":11,"column":86,"offset":313}}}],"position":{"start":{"line":11,"column":75,"offset":302},"end":{"line":11,"column":86,"offset":313}}},{"type":"text","value":".","position":{"start":{"line":11,"column":86,"offset":313},"end":{"line":11,"column":87,"offse

1t":314}}}],"position":{"start":{"line":10,"column":1,"offset":167},"end":{"line":11,"column":87,"offset":314}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":12,"column":3,"offset":317},"end":{"line":12,"column":6,"offset":320}}}],"position":{"start":{"line":12,"column":3,"offset":317},"end":{"line":12,"column":6,"offset":320}}},{"type":"text","value":" Integer","position":{"start":{"line":12,"column":6,"offset":320},"end":{"line":12,"column":14,"offset":328}}}],"position":{"start":{"line":12,"column":1,"offset":315},"end":{"line":12,"column":14,"offset":328}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":13,"column":3,"offset":331},"end":{"line":13,"column":6,"offset":334}}}],"position":{"start":{"line":13,"column":3,"offset":331},"end":{"line":13,"column":6,"offset":334}}},{"type":"text","value":" Integer","position":{"start":{"line":13,"column":6,"offset":334},"end":{"line":13,"column":14,"offset":342}}}],"position":{"start":{"line":13,"column":1,"offset":329},"end":{"line":13,"column":14,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"button","position":{"start":{"line":14,"column":3,"offset":345},"end":{"line":14,"column":11,"offset":353}}}],"position":{"start":{"line":14,"column":3,"offset":345},"end":{"line":14,"column":11,"offset":353}}},{"type":"text","value":" string (optional) - The button pressed, can be ","position":{"start":{"line":14,"column":11,"offset":353},"end":{"line":14,"column":59,"offset":401}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"left","position":{"start":{"line":14,"column":59,"offset":401},"end":{"line":14,"column":65,"offset":407}}}],"position":{"start":{"line":14,"column":59,"offset":401},"end":{"line":14,"column":65,"offset":407}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":65,"offset":407},"end":{"line":14,"column":67,"offset":409}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"middle","position":{"start":{"line":14,"column":67,"offset":409},"end":{"line":14,"column":75,"offset":417}}}],"position":{"start":{"line":14,"column":67,"offset":409},"end":{"line":14,"column":75,"offset":417}}},{"type":"text","value":", ","position":{"start":{"line":14,"column":75,"offset":417},"end":{"line":14,"column":77,"offset":419}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"right","position":{"start":{"line":14,"column":77,"offset":419},"end":{"line":14,"column":84,"offset":426}}}],"position":{"start":{"line":14,"column":77,"offset":419},"end":{"line":14,"column":84,"offset":426}}},{"type":"text","value":".","position":{"start":{"line":14,"column":84,"offset":426},"end":{"line":14,"column":85,"offset":427}}}],"position":{"start":{"line":14,"column":1,"offset":343},"end":{"line":14,"column":85,"offset":427}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"globalX","position":{"start":{"line":15,"column":3,"offset":430},"end":{"line":15,"column":12,"offset":439}}}],"position":{"start":{"line":15,"column":3,"offset":430},"end":{"line":15,"column":12,"offset":439}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":15,"column":12,"offset":439},"end":{"line":15,"column":31,"offset":458}}}],"position":{"start":{"line":15,"column":1,"offset":428},"end":{"line":15,"column":31,"offset":458}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"globalY","position":{"start":{"line":16,"column":3,"offset":461},"end":{"line":16,"column":12,"offset":470}}}],"position":{"start":{"line":16,"column":3,"offset":461},"end":{"line":16,"column":12,"offset":470}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":16,"column":12,"offset":470},"end":{"line":16,"column":31,"offset":489}}}],"position":{"start":{"line":16,"column":1,"offset":459},"end":{"line":16,"column":31,"offset":489}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"movementX","position":{"start":{"line":17,"column":3,"offset":492},"end":{"line":17,"column":14,"offset":503}}}],"position":{"start":{"line":17,"column":3,"offset":492},"end":{"line":17,"column":14,"offset":503}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":17,"column":14,"offset":503},"end":{"line":17,"column":33,"offset":522}}}],"position":{"start":{"line":17,"column":1,"offset":490},"end":{"line":17,"column":33,"offset":522}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"movementY","position":{"start":{"line":18,"column":3,"offset":525},"end":{"line":18,"column":14,"offset":536}}}],"position":{"start":{"line":18,"column":3,"offset":525},"end":{"line":18,"column":14,"offset":536}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":18,"column":14,"offset":536},"end":{"line":18,"column":33,"offset":555}}}],"position":{"start":{"line":18,"column":1,"offset":523},"end":{"line":18,"column":33,"offset":555}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"clickCount","position":{"start":{"line":19,"column":3,"offset":558},"end":{"line":19,"column":15,"offset":570}}}],"position":{"start":{"line":19,"column":3,"offset":558},"end":{"line":19,"column":15,"offset":570}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":19,"column":15,"offset":570},"end":{"line":19,"column":34,"offset":589}}}],"position":{"start":{"line":19,"column":1,"offset":556},"end":{"line":19,"column":34,"offset":589}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":167},"end":{"line":19,"column":34,"offset":589}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":20,"column":1,"offset":590}}}'})," | ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/mouse-wheel-input-event",title:"MouseWheelInputEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"MouseWheelInputEvent Object extends MouseInputEvent"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":195},"end":{"line":10,"column":9,"offset":201}}}],"position":{"start":{"line":10,"column":3,"offset":195},"end":{"line":10,"column":9,"offset":201}}},{"type":"text","value":" string - The type of the event, can be ","position":{"start":{"line":10,"column":9,"offset":201},"end":{"line":10,"column":49,"offset":241}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"mouseWheel","position":{"start":{"line":10,"column":49,"offset":241},"end":{"line":10,"column":61,"offset":253}}}],"position":{"start":{"line":10,"column":49,"offset":241},"end":{"line":10,"column":61,"offset":253}}},{"type":"text","value":".","position":{"start":{"line":10,"column":61,"offset":253},"end":{"line":10,"column":62,"offset":254}}}],"position":{"start":{"line":10,"column":1,"offset":193},"end":{"line":10,"column":62,"offset":254}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"deltaX","position":{"start":{"line":11,"column":3,"offset":257},"end":{"line":11,"column":11,"offset":265}}}],"position":{"start":{"line":11,"column":3,"offset":257},"end":{"line":11,"column":11,"offset":265}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":11,"column":11,"offset":265},"end":{"line":11,"column":30,"offset":284}}}],"position":{"start":{"line":11,"column":1,"offset":255},"end":{"line":11,"column":30,"offset":284}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"deltaY","position":{"start":{"line":12,"column":3,"offset":287},"end":{"line":12,"column":11,"offset":295}}}],"position":{"start":{"line":12,"column":3,"offset":287},"end":{"line":12,"column":11,"offset":295}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":12,"column":11,"offset":295},"end":{"line":12,"column":30,"offset":314}}}],"position":{"start":{"line":12,"column":1,"offset":285},"end":{"line":12,"column":30,"offset":314}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"wheelTicksX","position":{"start":{"line":13,"column":3,"offset":317},"end":{"line":13,"column":16,"offset":330}}}],"position":{"start":{"line":13,"column":3,"offset":317},"end":{"line":13,"column":16,"offset":330}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":13,"column":16,"offset":330},"end":{"line":13,"column":35,"offset":349}}}],"position":{"start":{"line":13,"column":1,"offset":315},"end":{"line":13,"column":35,"offset":349}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"wheelTicksY","position":{"start":{"line":14,"column":3,"offset":352},"end":{"line":14,"column":16,"offset":365}}}],"position":{"start":{"line":14,"column":3,"offset":352},"end":{"line":14,"column":16,"offset":365}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":14,"column":16,"offset":365},"end":{"line":14,"column":35,"offset":384}}}],"position":{"start":{"line":14,"column":1,"offset":350},"end":{"line":14,"column":35,"offset":384}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"accelerationRatioX","position":{"start":{"line":15,"column":3,"offset":387},"end":{"line":15,"column":23,"offset":407}}}],"position":{"start":{"line":15,"column":3,"offset":387},"end":{"line":15,"column":23,"offset":407}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":15,"column":23,"offset":407},"end":{"line":15,"column":42,"offset":426}}}],"position":{"start":{"line":15,"column":1,"offset":385},"end":{"line":15,"column":42,"offset":426}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"accelerationRatioY","position":{"start":{"line":16,"column":3,"offset":429},"end":{"line":16,"column":23,"offset":449}}}],"position":{"start":{"line":16,"column":3,"offset":429},"end":{"line":16,"column":23,"offset":449}}},{"type":"text","value":" Integer (optional)","position":{"start":{"line":16,"column":23,"offset":449},"end":{"line":16,"column":42,"offset":468}}}],"position":{"start":{"line":16,"column":1,"offset":427},"end":{"line":16,"column":42,"offset":468}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"hasPreciseScrollingDeltas","position":{"start":{"line":17,"column":3,"offset":471},"end":{"line":17,"column":30,"offset":498}}}],"position":{"start":{"line":17,"column":3,"offset":471},"end":{"line":17,"column":30,"offset":498}}},{"type":"text","value":" boolean (optional)","position":{"start":{"line":17,"column":30,"offset":498},"end":{"line":17,"column":49,"offset":517}}}],"position":{"start":{"line":17,"column":1,"offset":469},"end":{"line":17,"column":49,"offset":517}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"canScroll","position":{"start":{"line":18,"column":3,"offset":520},"end":{"line":18,"column":14,"offset":531}}}],"position":{"start":{"line":18,"column":3,"offset":520},"end":{"line":18,"column":14,"offset":531}}},{"type":"text","value":" boolean (optional)","position":{"start":{"line":18,"column":14,"offset":531},"end":{"line":18,"column":33,"offset":550}}}],"position":{"start":{"line":18,"column":1,"offset":518},"end":{"line":18,"column":33,"offset":550}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":193},"end":{"line":18,"column":33,"offset":550}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":19,"column":1,"offset":551}}}'})," | ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/keyboard-input-event",title:"KeyboardInputEvent",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"KeyboardInputEvent Object extends InputEvent"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":178},"end":{"line":10,"column":9,"offset":184}}}],"position":{"start":{"line":10,"column":3,"offset":178},"end":{"line":10,"column":9,"offset":184}}},{"type":"text","value":" string - The type of the event, can be ","position":{"start":{"line":10,"column":9,"offset":184},"end":{"line":10,"column":49,"offset":224}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"rawKeyDown","position":{"start":{"line":10,"column":49,"offset":224},"end":{"line":10,"column":61,"offset":236}}}],"position":{"start":{"line":10,"column":49,"offset":224},"end":{"line":10,"column":61,"offset":236}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":61,"offset":236},"end":{"line":10,"column":63,"offset":238}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyDown","position":{"start":{"line":10,"column":63,"offset":238},"end":{"line":10,"column":72,"offset":247}}}],"position":{"start":{"line":10,"column":63,"offset":238},"end":{"line":10,"column":72,"offset":247}}},{"type":"text","value":", ","position":{"start":{"line":10,"column":72,"offset":247},"end":{"line":10,"column":74,"offset":249}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyUp","position":{"start":{"line":10,"column":74,"offset":249},"end":{"line":10,"column":81,"offset":256}}}],"position":{"start":{"line":10,"column":74,"offset":249},"end":{"line":10,"column":81,"offset":256}}},{"type":"text","value":" or ","position":{"start":{"line":10,"column":81,"offset":256},"end":{"line":10,"column":85,"offset":260}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"char","position":{"start":{"line":10,"column":85,"offset":260},"end":{"line":10,"column":91,"offset":266}}}],"position":{"start":{"line":10,"column":85,"offset":260},"end":{"line":10,"column":91,"offset":266}}},{"type":"text","value":".","position":{"start":{"line":10,"column":91,"offset":266},"end":{"line":10,"column":92,"offset":267}}}],"position":{"start":{"line":10,"column":1,"offset":176},"end":{"line":10,"column":92,"offset":267}}},{"type":"text","value":"\\n"},{"type":"element","

1tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"keyCode","position":{"start":{"line":11,"column":3,"offset":270},"end":{"line":11,"column":12,"offset":279}}}],"position":{"start":{"line":11,"column":3,"offset":270},"end":{"line":11,"column":12,"offset":279}}},{"type":"text","value":" string - The character that will be sent\\nas the keyboard event. Should only use valid ","position":{"start":{"line":11,"column":12,"offset":279},"end":{"line":12,"column":48,"offset":368}}},{"type":"element","tagName":"a","properties":{"href":"/docs/latest/tutorial/keyboard-shortcuts#accelerators"},"children":[{"type":"text","value":"Accelerator","position":{"start":{"line":12,"column":49,"offset":369},"end":{"line":12,"column":60,"offset":380}}}],"position":{"start":{"line":12,"column":48,"offset":368},"end":{"line":12,"column":112,"offset":432}}},{"type":"text","value":"\\nkey codes.","position":{"start":{"line":12,"column":112,"offset":432},"end":{"line":13,"column":13,"offset":445}}}],"position":{"start":{"line":11,"column":1,"offset":268},"end":{"line":13,"column":13,"offset":445}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":176},"end":{"line":13,"column":13,"offset":445}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":14,"column":1,"offset":446}}}'})]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Sends an input ",(0,i.jsx)(t.code,{children:"event"})," to the page."]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.a,{href:"/docs/latest/api/browser-window",children:(0,i.jsx)(t.code,{children:"BrowserWindow"})})," containing the contents needs to be focused for\n",(0,i.jsx)(t.code,{children:"sendInputEvent()"})," to work."]})}),"\n",(0,i.jsx)(t.h4,{id:"contentsbeginframesubscriptiononlydirty-callback",children:(0,i.jsx)(t.code,{children:"contents.beginFrameSubscription([onlyDirty ,]callback)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"onlyDirty"})," boolean (optional) - Defaults to ",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"callback"})," Function","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"image"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:"NativeImage"})]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"dirtyRect"})," ",(0,i.jsx)(c.A,{url:"/docs/latest/api/structures/rectangle",title:"Rectangle",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"Rectangle Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"x","position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}}],"position":{"start":{"line":10,"column":3,"offset":107},"end":{"line":10,"column":6,"offset":110}}},{"type":"text","value":" number - The x coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":10,"column":6,"offset":110},"end":{"line":10,"column":85,"offset":189}}}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":10,"column":85,"offset":189}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"y","position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}}],"position":{"start":{"line":11,"column":3,"offset":192},"end":{"line":11,"column":6,"offset":195}}},{"type":"text","value":" number - The y coordinate of the origin of the rectangle (must be an integer).","position":{"start":{"line":11,"column":6,"offset":195},"end":{"line":11,"column":85,"offset":274}}}],"position":{"start":{"line":11,"column":1,"offset":190},"end":{"line":11,"column":85,"offset":274}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"width","position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}}],"position":{"start":{"line":12,"column":3,"offset":277},"end":{"line":12,"column":10,"offset":284}}},{"type":"text","value":" number - The width of the rectangle (must be an integer).","position":{"start":{"line":12,"column":10,"offset":284},"end":{"line":12,"column":68,"offset":342}}}],"position":{"start":{"line":12,"column":1,"offset":275},"end":{"line":12,"column":68,"offset":342}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"height","position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}}],"position":{"start":{"line":13,"column":3,"offset":345},"end":{"line":13,"column":11,"offset":353}}},{"type":"text","value":" number - The height of the rectangle (must be an integer).","position":{"start":{"line":13,"column":11,"offset":353},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":13,"column":1,"offset":343},"end":{"line":13,"column":70,"offset":412}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":105},"end":{"line":13,"column":70,"offset":412}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":14,"column":1,"offset":413}}}'})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Begin subscribing for presentation events and captured frames, the ",(0,i.jsx)(t.code,{children:"callback"}),"\nwill be called with ",(0,i.jsx)(t.code,{children:"callback(image, dirtyRect)"})," when there is a presentation\nevent."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"image"})," is an instance of ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:"NativeImage"})," that stores the\ncaptured frame."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"dirtyRect"})," is an object with ",(0,i.jsx)(t.code,{children:"x, y, width, height"})," properties that\ndescribes which part of the page was repainted. If ",(0,i.jsx)(t.code,{children:"onlyDirty"})," is set to\n",(0,i.jsx)(t.code,{children:"true"}),", ",(0,i.jsx)(t.code,{children:"image"})," will only contain the repainted area. ",(0,i.jsx)(t.code,{children:"onlyDirty"})," defaults to\n",(0,i.jsx)(t.code,{children:"false"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsendframesubscription",children:(0,i.jsx)(t.code,{children:"contents.endFrameSubscription()"})}),"\n",(0,i.jsx)(t.p,{children:"End subscribing for frame presentation events."}),"\n",(0,i.jsx)(t.h4,{id:"contentsstartdragitem",children:(0,i.jsx)(t.code,{children:"contents.startDrag(item)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"item"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"file"})," string - The path to the file being dragged."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"files"})," string[] (optional) - The paths to the files being dragged. (",(0,i.jsx)(t.code,{children:"files"})," will override ",(0,i.jsx)(t.code,{children:"file"})," field)"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"icon"})," ",(0,i.jsx)(t.a,{href:"/docs/latest/api/native-image",children:"NativeImage"}

1)," | string - The image must be\nnon-empty on macOS."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Sets the ",(0,i.jsx)(t.code,{children:"item"})," as dragging item for current drag-drop operation, ",(0,i.jsx)(t.code,{children:"file"})," is the\nabsolute path of the file to be dragged, and ",(0,i.jsx)(t.code,{children:"icon"})," is the image showing under\nthe cursor when dragging."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssavepagefullpath-savetype",children:(0,i.jsx)(t.code,{children:"contents.savePage(fullPath, saveType)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"fullPath"})," string - The absolute file path."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"saveType"})," string - Specify the save type.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"HTMLOnly"})," - Save only the HTML of the page."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"HTMLComplete"})," - Save complete-html page."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"MHTML"})," - Save complete-html page as MHTML."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})," - resolves if the page is saved."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"const { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow()\n\nwin.loadURL('https://github.com')\n\nwin.webContents.on('did-finish-load', async () => {\n  win.webContents\n    .savePage('/tmp/test.html', 'HTMLComplete')\n    .then(() => {\n      console.log('Page was saved successfully.')\n    })\n    .catch((err) => {\n      console.log(err)\n    })\n})\n"})}),"\n",(0,i.jsxs)(t.h4,{id:"contentsshowdefinitionforselection-macos",children:[(0,i.jsx)(t.code,{children:"contents.showDefinitionForSelection()"})," ",(0,i.jsx)(t.em,{className:"badge badge--primary",children:"macOS"})]}),"\n",(0,i.jsx)(t.p,{children:"Shows pop-up dictionary that searches the selected word on the page."}),"\n",(0,i.jsx)(t.h4,{id:"contentsisoffscreen",children:(0,i.jsx)(t.code,{children:"contents.isOffscreen()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - Indicates whether ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsstartpainting",children:(0,i.jsx)(t.code,{children:"contents.startPainting()"})}),"\n",(0,i.jsxs)(t.p,{children:["If ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled and not painting, start painting."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsstoppainting",children:(0,i.jsx)(t.code,{children:"contents.stopPainting()"})}),"\n",(0,i.jsxs)(t.p,{children:["If ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled and painting, stop painting."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsispainting",children:(0,i.jsx)(t.code,{children:"contents.isPainting()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - If ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled returns whether it is currently painting."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetframeratefps",children:(0,i.jsx)(t.code,{children:"contents.setFrameRate(fps)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"fps"})," Integer"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["If ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled sets the frame rate to the specified number.\nWhen ",(0,i.jsx)(t.code,{children:"webPreferences.offscreen.useSharedTexture"})," is ",(0,i.jsx)(t.code,{children:"false"})," only values between 1 and 240 are accepted."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetframerate",children:(0,i.jsx)(t.code,{children:"contents.getFrameRate()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Integer"})," - If ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled returns the current frame rate."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsinvalidate",children:(0,i.jsx)(t.code,{children:"contents.invalidate()"})}),"\n",(0,i.jsx)(t.p,{children:"Schedules a full repaint of the window this web contents is in."}),"\n",(0,i.jsxs)(t.p,{children:["If ",(0,i.jsx)(t.em,{children:"offscreen rendering"}

1)," is enabled invalidates the frame and generates a new\none through the ",(0,i.jsx)(t.code,{children:"'paint'"})," event."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetwebrtciphandlingpolicy",children:(0,i.jsx)(t.code,{children:"contents.getWebRTCIPHandlingPolicy()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - Returns the WebRTC IP Handling Policy."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetwebrtciphandlingpolicypolicy",children:(0,i.jsx)(t.code,{children:"contents.setWebRTCIPHandlingPolicy(policy)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"policy"})," string - Specify the WebRTC IP Handling Policy.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"default"})," - Exposes user's public and local IPs. This is the default\nbehavior. When this policy is used, WebRTC has the right to enumerate all\ninterfaces and bind them to discover public interfaces."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"default_public_interface_only"})," - Exposes user's public IP, but does not\nexpose user's local IP. When this policy is used, WebRTC should only use the\ndefault route used by http. This doesn't expose any local addresses."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"default_public_and_private_interfaces"})," - Exposes user's public and local\nIPs. When this policy is used, WebRTC should only use the default route used\nby http. This also exposes the associated default private address. Default\nroute is the route chosen by the OS on a multi-homed endpoint."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"disable_non_proxied_udp"})," - Does not expose public or local IPs. When this\npolicy is used, WebRTC should only use TCP to contact peers or servers unless\nthe proxy server supports UDP."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Setting the WebRTC IP handling policy allows you to control which IPs are\nexposed via WebRTC. See ",(0,i.jsx)(t.a,{href:"https://browserleaks.com/webrtc",children:"BrowserLeaks"})," for\nmore details."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetwebrtcudpportrange",children:(0,i.jsx)(t.code,{children:"contents.getWebRTCUDPPortRange()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Object"}),":"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"min"})," Integer - The minimum UDP port number that WebRTC should use."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"max"})," Integer - The maximum UDP port number that WebRTC should use."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["By default this value is ",(0,i.jsx)(t.code,{children:"{ min: 0, max: 0 }"})," , which would apply no restriction on the udp port range."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetwebrtcudpportrangeudpportrange",children:(0,i.jsx)(t.code,{children:"contents.setWebRTCUDPPortRange(udpPortRange)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"udpPortRange"})," Object","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"min"})," Integer - The minimum UDP port number that WebRTC should use."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"max"})," Integer - The maximum UDP port number that WebRTC should use."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Setting the WebRTC UDP Port Range allows you to restrict the udp port range used by WebRTC. By default the port range is unrestricted."}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["To reset to an unrestricted port range this value should be set to ",(0,i.jsx)(t.code,{children:"{ min: 0, max: 0 }"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetmediasourceidrequestwebcontents",children:(0,i.jsx)(t.code,{children:"contents.getMediaSourceId(requestWebContents)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"requestWebContents"})," WebContents - Web contents that the id will be registered to."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - The identifier of a WebContents stream. This identifier can be used\nwith ",(0,i.jsx)(t.code,{children:"navigator.mediaDevices.getUserMedia"})," using a ",(0,i.jsx)(t.code,{children:"chromeMediaSource"})," of ",(0,i.jsx)(t.code,{children:"tab"}),".\nThe identifier is restricted to the web contents that it is registered to and is only valid for 10 seconds.\nThe ",(0,i.jsx)(t.code,{children:"desktop"})," source only accepts screen and window identifiers from\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/desktop-capturer#desktopcapturergetsourcesoptions",children:(0,i.jsx)(t.code,{children:"desktopCapturer.getSources"})}),";\nto capture a WebContents use this identifier with the ",(0,i.jsx)(t.code,{children:"tab"})," source, or\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/session#sessetdisplaymediarequesthandlerhandler-opts",children:(0,i.jsx)(t.code,{children:"ses.setDisplayMediaRequestHandler"})}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetorcreatedevtoolstargetid",children:(0,i.jsx)(t.code,{children:"contents.getOrCreateDevToolsTargetId()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - The Chrome DevTools Protocol\n",(0,i.jsx)(t.a,{href:"https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID",children:"TargetID"}),"\nassociated with this WebContents. This is the reverse of\n",(0,i.jsx)(t.a,{href:"#webcontentsfromdevtoolstargetidtargetid",children:(0,i.jsx)(t.code,{children:"webContents.fromDevToolsTargetId()"})}),"."]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:"This method creates a new DevTools agent for this WebContents if one does not already exist."})}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetosprocessid",children:(0,i.jsx)(t.code,{children:"contents.getOSProcessId()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Integer"})," - The operating system ",(0,i.jsx)(t.code,{children:"pid"})," of the associated renderer\nprocess."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetprocessid",children:(0,i.jsx)(t.code,{children:"contents.getProcessId()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Integer"})," - The Chromium internal ",(0,i.jsx)(t.code,{children:"pid"})," of the associated renderer. Can\nbe compared to the ",(0,i.jsx)(t.code,{children:"frameProcessId"})," passed by frame specific navigation events\n(e.g. ",(0,i.jsx)(t.code,{children:"did-frame-navigate"}),")"]}),"\n",(0,i.jsx)(t.h4,{id:"contentsclone",children:(0,i.jsx)(t.code,{children:"contents.clone()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"WebContents"})," - A cloned WebContents instance. This method creates a copy\nof the WebContents with the following attributes:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"WebPreferences"})," - All preferences from the original WebContents are copied"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"SiteInstance"})," - Uses the same SiteInstance as the original. This means the cloned WebContents will reuse the same render process as the original when loading same-origin pages, and only spawn a new render process for cross-origin navigations. This process allocation behavior is consistent with window.open and tab duplication in Chromium. For more details, see ",(0,i.jsx)(t.a,{href:"https://www.chromium.org/developers/design-documents/site-isolation/",children:"Chromium's Site Isolation"})," design document."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Opener relationship"})," - Inherits the opener (window.opener) relationship"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Navigation state"})," - Copies the navigation history and controller state"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"The cloned WebContents is an independent instance with its own lifecycle that can be destroyed separately and will not contain any open web pages."}),"\n",(0,i.jsx)(t.p,{children:"This API is useful for use cases where you want to create a new WebContents that shares the same render process with the original for same-origin content, while maintaining full lifecycle independence. Additionally, reusing the existing render process can help optimize memory usage and page load speed to a certain extent, as it eliminates the overhead of spawning and initializing a new render process from scratch."}),"\n",(0,i.jsx)(t.h4,{id:"contentstakeheapsnapshotfilepath",children:(0,i.jsx)(t.code,{children:"contents.takeHeapSnapsh

1ot(filePath)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"filePath"})," string - Path to the output file."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"Promise<void>"})," - Indicates whether the snapshot has been created successfully."]}),"\n",(0,i.jsxs)(t.p,{children:["Takes a V8 heap snapshot and saves it to ",(0,i.jsx)(t.code,{children:"filePath"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsgetbackgroundthrottling",children:(0,i.jsx)(t.code,{children:"contents.getBackgroundThrottling()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"boolean"})," - whether or not this WebContents will throttle animations and timers\nwhen the page becomes backgrounded. This also affects the Page Visibility API."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetbackgroundthrottlingallowed",children:(0,i.jsx)(t.code,{children:"contents.setBackgroundThrottling(allowed)"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"changes":[{"pr-url":"https://github.com/electron/electron/pull/38924","description":"`WebContents.backgroundThrottling` set to false affects all `WebContents` in the host `BrowserWindow`","breaking-changes-header":"behavior-changed-webcontentsbackgroundthrottling-set-to-false-affects-all-webcontents-in-the-host-browserwindow"}]}',prReleaseVersionsJson:'{"38924":{"release":"28.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"allowed"})," boolean"]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Controls whether or not this WebContents will throttle animations and timers\nwhen the page becomes backgrounded. This also affects the Page Visibility API."}),"\n",(0,i.jsx)(t.h4,{id:"contentsgettype",children:(0,i.jsx)(t.code,{children:"contents.getType()"})}),"\n",(0,i.jsxs)(t.p,{children:["Returns ",(0,i.jsx)(t.code,{children:"string"})," - the type of the webContent. Can be ",(0,i.jsx)(t.code,{children:"backgroundPage"}),", ",(0,i.jsx)(t.code,{children:"window"}),", ",(0,i.jsx)(t.code,{children:"browserView"}),", ",(0,i.jsx)(t.code,{children:"remote"}),", ",(0,i.jsx)(t.code,{children:"webview"})," or ",(0,i.jsx)(t.code,{children:"offscreen"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentssetimageanimationpolicypolicy",children:(0,i.jsx)(t.code,{children:"contents.setImageAnimationPolicy(policy)"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"policy"})," string - Can be ",(0,i.jsx)(t.code,{children:"animate"}),", ",(0,i.jsx)(t.code,{children:"animateOnce"})," or ",(0,i.jsx)(t.code,{children:"noAnimation"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Sets the image animation policy for this webContents.  The policy only affects\n",(0,i.jsx)(t.em,{children:"new"})," images, existing images that are currently being animated are unaffected.\nThis is a known limitation in Chromium, you can force image animation to be\nrecalculated with ",(0,i.jsx)(t.code,{children:"img.src = img.src"})," which will result in no network traffic\nbut will update the animation policy."]}),"\n",(0,i.jsxs)(t.p,{children:["This corresponds to the ",(0,i.jsx)(t.a,{href:"https://developer.chrome.com/docs/extensions/reference/accessibilityFeatures/#property-animationPolicy",children:"animationPolicy"})," accessibility feature in Chromium."]}),"\n",(0,i.jsx)(t.h3,{id:"instance-properties",children:"Instance Properties"}),"\n",(0,i.jsxs)(t.h4,{id:"contentsipc-readonly",children:[(0,i.jsx)(t.code,{children:"contents.ipc"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["An ",(0,i.jsx)(t.a,{href:"/docs/latest/api/ipc-main",children:(0,i.jsx)(t.code,{children:"IpcMain"})})," scoped to just IPC messages sent from this\nWebContents."]}),"\n",(0,i.jsxs)(t.p,{children:["IPC messages sent with ",(0,i.jsx)(t.code,{children:"ipcRenderer.send"}),", ",(0,i.jsx)(t.code,{children:"ipcRenderer.sendSync"})," or\n",(0,i.jsx)(t.code,{children:"ipcRenderer.postMessage"})," will be delivered in the following order:"]}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"contents.on('ipc-message')"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"contents.mainFrame.on(channel)"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"contents.ipc.on(channel)"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"ipcMain.on(channel)"})}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Handlers registered with ",(0,i.jsx)(t.code,{children:"invoke"})," will be checked in the following order. The\nfirst one that is defined will be called, the rest will be ignored."]}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"contents.mainFrame.handle(channel)"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"contents.handle(channel)"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"ipcMain.handle(channel)"})}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["A handler or event listener registered on the WebContents will receive IPC\nmessages sent from any frame, including child frames. In most cases, only the\nmain frame can send IPC messages. However, if the ",(0,i.jsx)(t.code,{children:"nodeIntegrationInSubFrames"}),"\noption is enabled, it is possible for child frames to send IPC messages also.\nIn that case, handlers should check the ",(0,i.jsx)(t.code,{children:"senderFrame"})," property of the IPC event\nto ensure that the message is coming from the expected frame. Alternatively,\nregister handlers on the appropriate frame directly using the\n",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-frame-main#frameipc-readonly",children:(0,i.jsx)(t.code,{children:"WebFrameMain.ipc"})})," interface."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsaudiomuted",children:(0,i.jsx)(t.code,{children:"contents.audioMuted"})}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"boolean"})," property that determines whether this page is muted."]}),"\n",(0,i.jsx)(t.h4,{id:"contentscaretbrowsingenabled",children:(0,i.jsx)(t.code,{children:"contents.caretBrowsingEnabled"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"added":[{"pr-url":"https://github.com/electron/electron/pull/52696"}]}',prReleaseVersionsJson:'{"52696":{"release":null,"backports":["44.0.0","43.6.0"]}}'}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"boolean"})," property that determines whether caret browsing is enabled for this page."]}),"\n",(0,i.jsx)(t.p,{children:"When enabled, a movable cursor is placed in the page's text, allowing the user to navigate and select content with the keyboard. Changes apply to the live page without reloading it."}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"<webview>"})," guest inherits this value from its embedder when it is created and\nthen tracks it independently, so disabling caret browsing on the embedder leaves\nan existing guest enabled."]}),"\n",(0,i.jsxs)(t.p,{children:["While any ",(0,i.jsx)(t.code,{children:"WebContents"})," in the process has caret browsing enabled, assistive\ntechnology is notified process-wide that caret browsing is active, so that screen\nreaders report the caret's position as it moves. That notification is only\nwithdrawn once every ",(0,i.jsx)(t.code,{children:"WebContents"})," that enabled caret browsing has either\ndisabled it or been destroyed."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsuseragent",children:(0,i.jsx)(t.code,{children:"contents.userAgent"})}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"string"})," property that determines the user agent for this web page."]}),"\n",(0,i.jsx)(t.h4,{id:"contentszoomlevel",children:(0,i.jsx)(t.code,{children:"contents.zoomLevel"})}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"number"})," property that determines the zoom level for this web contents."]}),"\n",(0,i.jsxs)(t.p,{children:["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 ",(0,i.jsx)(t.code,{children:"scale := 1.2 ^ level"}),"."]}),"\n",(0,i.jsx)(t.h4,{id:"contentszoomfactor",children:(0,i.jsx)(t.code,{children:"contents.zoomFactor"})}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"number"})," property that determines the zoom factor for this web contents."]}),"\n",(0,i.jsx)(t.p,{children:"The zoom factor is the zoom percent divided by 100, so 300% = 3.0."}),"\n",(0,i.jsx)(t.h4,{id:"contentszoommode",children:(0,i.jsx)(t.code,{children:"contents.zoomMode"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"added":[{"pr-url":"https://github.com/electron/electron/pull/49962"}]}',prReleaseVersionsJson:'{"49962":{"release":"44.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"string"})," property that determines the zoom mode for this web contents."]}),"\n",(0,i.jsxs)(t.p,{children:["See ",(0,i.jsx)(t.a,{href:"#contentssetzoommodemode",children:(0,i.jsx)(t.code,{children:"contents.setZoomMode"})})," for a description of the\navailable modes."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsframerate",children:(0,i.jsx)(t.code,{children:"contents.frameRate"})}),"\n",(0,i.jsxs)(t.p,{children:["An ",(0,i.jsx)(t.code,{children:"Integer"})," property that sets the frame rate of the web contents to the specified number.\nOnly values between 1 and 240 are accepted."]}),"\n",(0,i.jsxs)(t.p,{children:["Only applicable if ",(0,i.jsx)(t.em,{children:"offscreen rendering"})," is enabled."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsid-readonly",children:[(0,i.jsx)(t.code,{children:"contents.id"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"Integer"})," representing the unique ID of this WebContents. Each ID is unique among all ",(0,i.jsx)(t.code,{children:"WebContents"})," instances of the entire Electron application."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentssession-readonly",children:[(0,i.jsx)(t.code,{children:"contents.session"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.a,{href:"/docs/latest/api/session",children:(0,i.jsx)(t.code,{children:"Session"})})," used by this webContents."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsnavigationhistory-readonly",children:[(0,i.jsx)(t.code,{children:"contents.navigationHistory"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.a,{href:"/docs/latest/api/navigation-history",children:(0,i.jsx)(t.code,{children:"NavigationHistory"})})," used by this webContents."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentshostwebcontents-readonly",children:[(0,i.jsx)(t.code,{children:"contents.hostWebContents"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"WebContents | null"})," property that represents a ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-contents",children:(0,i.jsx)(t.code,{children:"WebContents"})}),"\ninstance that might own this ",(0,i.jsx)(t.code,{children:"WebContents"}),"."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsdevtoolswebcontents-readonly",children:[(0,i.jsx)(t.code,{children:"contents.devToolsWebContents"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"WebContents | null"})," property that represents the DevTools ",(0,i.jsx)(t.code,{children:"WebContents"})," associated with a given ",(0,i.jsx)(t.code,{children:"WebContents"}),"."]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["Users should never store this object because it may become ",(0,i.jsx)(t.code,{children:"null"}),"\nwhen the DevTools has been closed."]})}),"\n",(0,i.jsxs)(t.h4,{id:"contentsdebugger-readonly",children:[(0,i.jsx)(t.code,{children:"contents.debugger"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.a,{href:"/docs/latest/api/debugger",children:(0,i.jsx)(t.code,{children:"Debugger"})})," instance for this webContents."]}),"\n",(0,i.jsx)(t.h4,{id:"contentsbackgroundthrottling",children:(0,i.jsx)(t.code,{children:"contents.backgroundThrottling"})}),"\n",(0,i.jsx)(l.A,{apiHistoryJson:'{"changes":[{"pr-url":"https://github.com/electron/electron/pull/38924","description":"`WebContents.backgroundThrottling` set to false affects all `WebContents` in the host `BrowserWindow`","breaking-changes-header":"behavior-changed-webcontentsbackgroundthrottling-set-to-false-affects-all-webcontents-in-the-host-browserwindow"}]}',prReleaseVersionsJson:'{"38924":{"release":"28.0.0","backports":[]}}'}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.code,{children:"boolean"})," property that determines whether or not this WebContents will throttle animations and timers\nwhen the page becomes backgrounded. This also affects the Page Visibility API."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsmainframe-readonly",children:[(0,i.jsx)(t.code,{children:"contents.mainFrame"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-frame-main",children:(0,i.jsx)(t.code,{children:"WebFrameMain"})})," property that represents the top frame of the page's frame hierarchy."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsopener-readonly",children:[(0,i.jsx)(t.code,{children:"contents.opener"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-frame-main",children:(0,i.jsx)(t.code,{children:"WebFrameMain | null"})})," property that represents the frame that opened this WebContents, either\nwith open(), or by navigating a link

1with a target attribute."]}),"\n",(0,i.jsxs)(t.h4,{id:"contentsfocusedframe-readonly",children:[(0,i.jsx)(t.code,{children:"contents.focusedFrame"})," ",(0,i.jsx)(t.em,{className:"badge badge--info",children:"Readonly"})]}),"\n",(0,i.jsxs)(t.p,{children:["A ",(0,i.jsx)(t.a,{href:"/docs/latest/api/web-frame-main",children:(0,i.jsx)(t.code,{children:"WebFrameMain | null"})})," property that represents the currently focused frame in this WebContents.\nCan be the top frame, an inner ",(0,i.jsx)(t.code,{children:"<iframe>"}),", or ",(0,i.jsx)(t.code,{children:"null"})," if nothing is focused."]})]})}function u(e={}){let{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},40329(e,t,n){n.d(t,{A:()=>d});var o=n(74848),i=n(20053),s=n(96540),l=n(75392),c=n.n(l),r=n(83561);let a=e=>(0,o.jsx)("article",{ref:e.innerRef,id:"structures-tooltip",role:"tooltip",className:(0,i.A)("alert","alert--info","shadow--md","card_ZoSr"),style:e.position,children:(0,o.jsx)("div",{className:"card__body",dangerouslySetInnerHTML:{__html:(0,r.V)(JSON.parse(e.content))}})}),d=function(e){let{Portal:t}=c()(),n=(0,s.useRef)(null),i=(0,s.useRef)(null),[l,r]=(0,s.useState)(!1),[d,f]=(0,s.useState)(void 0);(0,s.useEffect)(()=>{if(l){let e={x:0,y:0},t=n.current.getBoundingClientRect(),o=window.innerHeight/2<t.y,s=window.innerWidth/2<t.x;o?e.y=i.current.clientHeight+-2:e.y=-t.height- -2,s?e.x=i.current.clientWidth:e.x=0,f({top:n.current.offsetTop-e.y,left:n.current.offsetLeft-e.x})}},[l]);let p=(0,s.useCallback)(()=>{r(!0)},[]),u=(0,s.useCallback)(()=>{r(!1)},[]);return(0,o.jsxs)("a",{"aria-describedby":"structures-tooltip",href:e.url,ref:n,className:"link_nCrB",onMouseEnter:p,onMouseLeave:u,children:[e.title,!!l&&(0,o.jsx)(t,{children:(0,o.jsx)(a,{innerRef:i,position:d,...e})})]})}},56346(e,t,n){n.d(t,{A:()=>r});var o=n(74848),i=n(52918);n(96540);var s=n(35778),l=n(99589);let c={"api-history":"api-history_li9V","api-added":"api-added_XqIp","api-deprecated":"api-deprecated_PIol"},r=e=>{let{apiHistoryJson:t,prReleaseVersionsJson:n}=e,r=JSON.parse(t),a=JSON.parse(n),d=(e,t)=>(t??[]).map(t=>{var n;let i,r,d,f,p;return n=a[Number(t["pr-url"].split("/").at(-1))],r=t["pr-url"]+"-"+e,d=l.rsort(n?.backports??[]).map(e=>(e.endsWith(".0.0")?">

1=":"^")+e),(f=n?.release)&&!d.find(e=>e.startsWith(">="))&&d.unshift(`>=${f}`),p=d.map(e=>(0,o.jsx)("a",{href:t["pr-url"],target:"_blank",rel:"noopener noreferrer",children:(0,o.jsx)("pre",{children:e})},e)),i="description"in t?(0,o.jsx)(s.o,{allowedElements:["a","code","em","p","pre","strong"],children:t.description}):(0,o.jsx)("pre",{className:c[e.toLowerCase().split(" ").join("-")],children:e},r),"breaking-changes-header"in t&&(i=(0,o.jsx)("a",{href:"/docs/latest/breaking-changes#"+t["breaking-changes-header"],target:"_blank",rel:"noopener noreferrer",children:i})),(0,o.jsxs)("tr",{children:[(0,o.jsx)("td",{children:0!==p.length?p:(0,o.jsx)("pre",{children:"None"})}),(0,o.jsx)("td",{children:i})]},r)}),f=[...d("API DEPRECATED",r.deprecated),...d("API CHANGED",r.changes),...d("API ADDED",r.added)];return(0,o.jsx)(i.B,{className:c["api-history"],summary:(0,o.jsx)("summary",{children:"History"}),children:(0,o.jsxs)("table",{children:[(0,o.jsx)("thead",{children:(0,o.jsxs)("tr",{children:[(0,o.jsx)("th",{children:"Version(s)"}),(0,o.jsx)("th",{children:"Changes"})]})}),(0,o.jsx)("tbody",{children:f})]})})}}}]);

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.