|
@@ -237,7 +237,7 @@ See [`window.open()`](window-open.md) for more details and how to use this in co
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
-* `details` Event<>
|
|
|
+* `details` Event\<\>
|
|
|
* `url` string - The URL the frame is navigating to.
|
|
|
* `isSameDocument` boolean - This event does not fire for same document navigations using window.history api and reference fragment navigations.
|
|
|
This property is always set to `false` for this event.
|
|
@@ -270,7 +270,7 @@ Calling `event.preventDefault()` will prevent the navigation.
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
-* `details` Event<>
|
|
|
+* `details` Event\<\>
|
|
|
* `url` string - The URL the frame is navigating to.
|
|
|
* `isSameDocument` boolean - This event does not fire for same document navigations using window.history api and reference fragment navigations.
|
|
|
This property is always set to `false` for this event.
|
|
@@ -300,7 +300,7 @@ Calling `event.preventDefault()` will prevent the navigation.
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
-* `details` Event<>
|
|
|
+* `details` Event\<\>
|
|
|
* `url` string - The URL the frame is navigating to.
|
|
|
* `isSameDocument` boolean - Whether the navigation happened without changing
|
|
|
document. Examples of same document navigations are reference fragment
|
|
@@ -324,7 +324,7 @@ Emitted when any frame (including main) starts navigating.
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
-* `details` Event<>
|
|
|
+* `details` Event\<\>
|
|
|
* `url` string - The URL the frame is navigating to.
|
|
|
* `isSameDocument` boolean - Whether the navigation happened without changing
|
|
|
document. Examples of same document navigations are reference fragment
|
|
@@ -355,7 +355,7 @@ redirect).
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
-* `details` Event<>
|
|
|
+* `details` Event\<\>
|
|
|
* `url` string - The URL the frame is navigating to.
|
|
|
* `isSameDocument` boolean - Whether the navigation happened without changing
|
|
|
document. Examples of same document navigations are reference fragment
|
|
@@ -674,7 +674,7 @@ Emitted when media is paused or done playing.
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
-* `event` Event<>
|
|
|
+* `event` Event\<\>
|
|
|
* `audible` boolean - True if one or more frames or child `webContents` are emitting audio.
|
|
|
|
|
|
Emitted when media becomes audible or inaudible.
|
|
@@ -894,7 +894,7 @@ Returns:
|
|
|
* `webPreferences` [WebPreferences](structures/web-preferences.md) - The web preferences that will be used by the guest
|
|
|
page. This object can be modified to adjust the preferences for the guest
|
|
|
page.
|
|
|
-* `params` Record<string, string> - The other `<webview>` parameters such as the `src` URL.
|
|
|
+* `params` Record\<string, string\> - The other `<webview>` parameters such as the `src` URL.
|
|
|
This object can be modified to adjust the parameters of the guest page.
|
|
|
|
|
|
Emitted when a `<webview>`'s web contents is being attached to this web
|
|
@@ -1014,7 +1014,7 @@ win.webContents.loadURL('https://github.com', options)
|
|
|
|
|
|
* `filePath` string
|
|
|
* `options` Object (optional)
|
|
|
- * `query` Record<string, string> (optional) - Passed to `url.format()`.
|
|
|
+ * `query` Record\<string, string\> (optional) - Passed to `url.format()`.
|
|
|
* `search` string (optional) - Passed to `url.format()`.
|
|
|
* `hash` string (optional) - Passed to `url.format()`.
|
|
|
|
|
@@ -1045,7 +1045,7 @@ win.loadFile('src/index.html')
|
|
|
|
|
|
* `url` string
|
|
|
* `options` Object (optional)
|
|
|
- * `headers` Record<string, string> (optional) - HTTP request headers.
|
|
|
+ * `headers` Record\<string, string\> (optional) - HTTP request headers.
|
|
|
|
|
|
Initiates a download of the resource at `url` without navigating. The
|
|
|
`will-download` event of `session` will be triggered.
|
|
@@ -1282,7 +1282,7 @@ Ignore application menu shortcuts while this web contents is focused.
|
|
|
|
|
|
#### `contents.setWindowOpenHandler(handler)`
|
|
|
|
|
|
-* `handler` Function<{action: 'deny'} | {action: 'allow', outlivesOpener?: boolean, overrideBrowserWindowOptions?: BrowserWindowConstructorOptions}>
|
|
|
+* `handler` Function\<{action: 'deny'} | {action: 'allow', outlivesOpener?: boolean, overrideBrowserWindowOptions?: BrowserWindowConstructorOptions}\>
|
|
|
* `details` Object
|
|
|
* `url` string - The _resolved_ version of the URL passed to `window.open()`. e.g. opening a window with `window.open('foo')` will yield something like `https://the-origin/the/current/path/foo`.
|
|
|
* `frameName` string - Name of the window provided in `window.open()`
|
|
@@ -1560,7 +1560,7 @@ Returns `Promise<PrinterInfo[]>` - Resolves with a [`PrinterInfo[]`](structures/
|
|
|
* `from` number - Index of the first page to print (0-based).
|
|
|
* `to` number - Index of the last page to print (inclusive) (0-based).
|
|
|
* `duplexMode` string (optional) - Set the duplex mode of the printed web page. Can be `simplex`, `shortEdge`, or `longEdge`.
|
|
|
- * `dpi` Record<string, number> (optional)
|
|
|
+ * `dpi` Record\<string, number\> (optional)
|
|
|
* `horizontal` number (optional) - The horizontal dpi.
|
|
|
* `vertical` number (optional) - The vertical dpi.
|
|
|
* `header` string (optional) - string to be printed as page header.
|