fix(docs): fix all missing dots and add some links
This commit is contained in:
Toinane
parent
59607c9a17
commit
323ea2b27b
24 changed files with 148 additions and 148 deletions
|
|
@ -91,7 +91,7 @@ The `autoUpdater` object has the following methods:
|
|||
### `autoUpdater.setFeedURL(url[, requestHeaders])`
|
||||
|
||||
* `url` String
|
||||
* `requestHeaders` Object _macOS_ (optional) - HTTP request headers.
|
||||
* `requestHeaders` Object (optional) _macOS_ - HTTP request headers.
|
||||
|
||||
Sets the `url` and initialize the auto updater.
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ specified, `partition` is ignored.
|
|||
* `protocol` String (optional) - The protocol scheme in the form 'scheme:'.
|
||||
Currently supported values are 'http:' or 'https:'. Defaults to 'http:'.
|
||||
* `host` String (optional) - The server host provided as a concatenation of
|
||||
the hostname and the port number 'hostname:port'
|
||||
the hostname and the port number 'hostname:port'.
|
||||
* `hostname` String (optional) - The server host name.
|
||||
* `port` Integer (optional) - The server's listening port number.
|
||||
* `path` String (optional) - The path part of the request URL.
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ The following events are available on instances of `Cookies`:
|
|||
#### Event: 'changed'
|
||||
|
||||
* `event` Event
|
||||
* `cookie` [Cookie](structures/cookie.md) - The cookie that was changed
|
||||
* `cookie` [Cookie](structures/cookie.md) - The cookie that was changed.
|
||||
* `cause` String - The cause of the change with one of the following values:
|
||||
* `explicit` - The cookie was changed directly by a consumer's action.
|
||||
* `overwrite` - The cookie was automatically removed due to an insert
|
||||
|
|
@ -62,7 +62,7 @@ The following methods are available on instances of `Cookies`:
|
|||
`url`. Empty implies retrieving cookies of all urls.
|
||||
* `name` String (optional) - Filters cookies by name.
|
||||
* `domain` String (optional) - Retrieves cookies whose domains match or are
|
||||
subdomains of `domains`
|
||||
subdomains of `domains`.
|
||||
* `path` String (optional) - Retrieves cookies whose path matches `path`.
|
||||
* `secure` Boolean (optional) - Filters cookies by their Secure property.
|
||||
* `session` Boolean (optional) - Filters out session or persistent cookies.
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ The `crashReporter` module has the following methods:
|
|||
* `extra` Object (optional) - An object you can define that will be sent along with the
|
||||
report. Only string properties are sent correctly. Nested objects are not
|
||||
supported and the property names and values must be less than 64 characters long.
|
||||
* `crashesDirectory` String (optional) - Directory to store the crashreports temporarily (only used when the crash reporter is started via `process.crashReporter.start`)
|
||||
* `crashesDirectory` String (optional) - Directory to store the crashreports temporarily (only used when the crash reporter is started via `process.crashReporter.start`).
|
||||
|
||||
You are required to call this method before using any other `crashReporter` APIs
|
||||
and in each process (main/renderer) from which you want to collect crash reports.
|
||||
|
|
@ -109,7 +109,7 @@ the `start` method or `setUploadToServer`.
|
|||
|
||||
### `crashReporter.setUploadToServer(uploadToServer)` _Linux_ _macOS_
|
||||
|
||||
* `uploadToServer` Boolean _macOS_ - Whether reports should be submitted to the server
|
||||
* `uploadToServer` Boolean _macOS_ - Whether reports should be submitted to the server.
|
||||
|
||||
This would normally be controlled by user preferences. This has no effect if
|
||||
called before `start` is called.
|
||||
|
|
@ -142,7 +142,7 @@ a `multipart/form-data` `POST`:
|
|||
* `ver` String - The version of Electron.
|
||||
* `platform` String - e.g. 'win32'.
|
||||
* `process_type` String - e.g. 'renderer'.
|
||||
* `guid` String - e.g. '5e1286fc-da97-479e-918b-6bfb0c3d1c72'
|
||||
* `guid` String - e.g. '5e1286fc-da97-479e-918b-6bfb0c3d1c72'.
|
||||
* `_version` String - The version in `package.json`.
|
||||
* `_productName` String - The product name in the `crashReporter` `options`
|
||||
object.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ The `dialog` module has the following methods:
|
|||
|
||||
### `dialog.showOpenDialog([browserWindow, ]options[, callback])`
|
||||
|
||||
* `browserWindow` BrowserWindow (optional)
|
||||
* `browserWindow` [BrowserWindow](browser-window.md) (optional)
|
||||
* `options` Object
|
||||
* `title` String (optional)
|
||||
* `defaultPath` String (optional)
|
||||
|
|
@ -38,16 +38,16 @@ The `dialog` module has the following methods:
|
|||
* `openDirectory` - Allow directories to be selected.
|
||||
* `multiSelections` - Allow multiple paths to be selected.
|
||||
* `showHiddenFiles` - Show hidden files in dialog.
|
||||
* `createDirectory` - Allow creating new directories from dialog. _macOS_
|
||||
* `promptToCreate` - Prompt for creation if the file path entered
|
||||
* `createDirectory` _macOS_ - Allow creating new directories from dialog.
|
||||
* `promptToCreate` _Windows_ - Prompt for creation if the file path entered
|
||||
in the dialog does not exist. This does not actually create the file at
|
||||
the path but allows non-existent paths to be returned that should be
|
||||
created by the application. _Windows_
|
||||
* `noResolveAliases` - Disable the automatic alias (symlink) path
|
||||
created by the application.
|
||||
* `noResolveAliases` _macOS_ - Disable the automatic alias (symlink) path
|
||||
resolution. Selected aliases will now return the alias path instead of
|
||||
their target path. _macOS_
|
||||
* `treatPackageAsDirectory` - Treat packages, such as `.app` folders,
|
||||
as a directory instead of a file. _macOS_
|
||||
their target path.
|
||||
* `treatPackageAsDirectory` _macOS_ - Treat packages, such as `.app` folders,
|
||||
as a directory instead of a file.
|
||||
* `message` String (optional) _macOS_ - Message to display above input
|
||||
boxes.
|
||||
* `callback` Function (optional)
|
||||
|
|
@ -77,7 +77,7 @@ The `extensions` array should contain extensions without wildcards or dots (e.g.
|
|||
`'*'` wildcard (no other wildcard is supported).
|
||||
|
||||
If a `callback` is passed, the API call will be asynchronous and the result
|
||||
will be passed via `callback(filenames)`
|
||||
will be passed via `callback(filenames)`.
|
||||
|
||||
**Note:** On Windows and Linux an open dialog can not be both a file selector
|
||||
and a directory selector, so if you set `properties` to
|
||||
|
|
@ -86,7 +86,7 @@ shown.
|
|||
|
||||
### `dialog.showSaveDialog([browserWindow, ]options[, callback])`
|
||||
|
||||
* `browserWindow` BrowserWindow (optional)
|
||||
* `browserWindow` [BrowserWindow](browser-window.md) (optional)
|
||||
* `options` Object
|
||||
* `title` String (optional)
|
||||
* `defaultPath` String (optional) - Absolute directory path, absolute file
|
||||
|
|
@ -111,11 +111,11 @@ The `filters` specifies an array of file types that can be displayed, see
|
|||
`dialog.showOpenDialog` for an example.
|
||||
|
||||
If a `callback` is passed, the API call will be asynchronous and the result
|
||||
will be passed via `callback(filename)`
|
||||
will be passed via `callback(filename)`.
|
||||
|
||||
### `dialog.showMessageBox([browserWindow, ]options[, callback])`
|
||||
|
||||
* `browserWindow` BrowserWindow (optional)
|
||||
* `browserWindow` [BrowserWindow](browser-window.md) (optional)
|
||||
* `options` Object
|
||||
* `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or
|
||||
`"warning"`. On Windows, `"question"` displays the same icon as `"info"`, unless
|
||||
|
|
@ -152,7 +152,7 @@ will be passed via `callback(filename)`
|
|||
converted to `Vie_w` on Linux and `View` on macOS and can be selected
|
||||
via `Alt-W` on Windows and Linux.
|
||||
* `callback` Function (optional)
|
||||
* `response` Number - The index of the button that was clicked
|
||||
* `response` Number - The index of the button that was clicked.
|
||||
* `checkboxChecked` Boolean - The checked state of the checkbox if
|
||||
`checkboxLabel` was set. Otherwise `false`.
|
||||
|
||||
|
|
@ -169,8 +169,8 @@ will be asynchronous and the result will be passed via `callback(response)`.
|
|||
|
||||
### `dialog.showErrorBox(title, content)`
|
||||
|
||||
* `title` String - The title to display in the error box
|
||||
* `content` String - The text content to display in the error box
|
||||
* `title` String - The title to display in the error box.
|
||||
* `content` String - The text content to display in the error box.
|
||||
|
||||
Displays a modal dialog that shows an error message.
|
||||
|
||||
|
|
@ -181,7 +181,7 @@ and no GUI dialog will appear.
|
|||
|
||||
### `dialog.showCertificateTrustDialog([browserWindow, ]options, callback)` _macOS_ _Windows_
|
||||
|
||||
* `browserWindow` BrowserWindow (optional)
|
||||
* `browserWindow` [BrowserWindow](browser-window.md) (optional)
|
||||
* `options` Object
|
||||
* `certificate` [Certificate](structures/certificate.md) - The certificate to trust/import.
|
||||
* `message` String - The message to display to the user.
|
||||
|
|
@ -202,7 +202,7 @@ On Windows the options are more limited, due to the Win32 APIs used:
|
|||
## Sheets
|
||||
|
||||
On macOS, dialogs are presented as sheets attached to a window if you provide
|
||||
a `BrowserWindow` reference in the `browserWindow` parameter, or modals if no
|
||||
a [`BrowserWindow`](browser-window.md) reference in the `browserWindow` parameter, or modals if no
|
||||
window is provided.
|
||||
|
||||
You can call `BrowserWindow.getCurrentWindow().setSheetOffset(offset)` to change
|
||||
|
|
|
|||
|
|
@ -84,12 +84,12 @@ win.show()
|
|||
the user's system).
|
||||
* On Windows operating systems, transparent windows will not work when DWM is
|
||||
disabled.
|
||||
* On Linux users have to put `--enable-transparent-visuals --disable-gpu` in
|
||||
* On Linux, users have to put `--enable-transparent-visuals --disable-gpu` in
|
||||
the command line to disable GPU and allow ARGB to make transparent window,
|
||||
this is caused by an upstream bug that [alpha channel doesn't work on some
|
||||
NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on
|
||||
Linux.
|
||||
* On Mac the native window shadow will not be shown on a transparent window.
|
||||
* On Mac, the native window shadow will not be shown on a transparent window.
|
||||
|
||||
## Click-through window
|
||||
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ unless you know what you are doing you should never use it.
|
|||
* `channel` String
|
||||
* `...args` any[]
|
||||
|
||||
Sends a message to a window with `windowid` via `channel`
|
||||
Sends a message to a window with `windowid` via `channel`.
|
||||
|
||||
### `ipcRenderer.sendToHost(channel[, arg1][, arg2][, ...])`
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ See [`Menu`](menu.md) for examples.
|
|||
* `click` Function (optional) - Will be called with
|
||||
`click(menuItem, browserWindow, event)` when the menu item is clicked.
|
||||
* `menuItem` MenuItem
|
||||
* `browserWindow` BrowserWindow
|
||||
* `browserWindow` [BrowserWindow](browser-window.md)
|
||||
* `event` Event
|
||||
* `role` String (optional) - Define the action of the menu item, when specified the
|
||||
`click` property will be ignored. See [roles](#roles).
|
||||
|
|
@ -27,9 +27,9 @@ See [`Menu`](menu.md) for examples.
|
|||
* `visible` Boolean (optional) - If false, the menu item will be entirely hidden.
|
||||
* `checked` Boolean (optional) - Should only be specified for `checkbox` or `radio` type
|
||||
menu items.
|
||||
* `submenu` (MenuItemConstructorOptions[] | Menu) (optional) - Should be specified for `submenu` type menu items. If
|
||||
* `submenu` (MenuItemConstructorOptions[] | [Menu](menu.md)) (optional) - Should be specified for `submenu` type menu items. If
|
||||
`submenu` is specified, the `type: 'submenu'` can be omitted. If the value
|
||||
is not a `Menu` then it will be automatically converted to one using
|
||||
is not a [`Menu`](menu.md) then it will be automatically converted to one using
|
||||
`Menu.buildFromTemplate`.
|
||||
* `id` String (optional) - Unique within a single menu. If defined then it can be used
|
||||
as a reference to this item by the position attribute.
|
||||
|
|
@ -57,39 +57,39 @@ The `role` property can have following values:
|
|||
* `pasteandmatchstyle`
|
||||
* `selectall`
|
||||
* `delete`
|
||||
* `minimize` - Minimize current window
|
||||
* `close` - Close current window
|
||||
* `quit`- Quit the application
|
||||
* `reload` - Reload the current window
|
||||
* `minimize` - Minimize current window.
|
||||
* `close` - Close current window.
|
||||
* `quit`- Quit the application.
|
||||
* `reload` - Reload the current window.
|
||||
* `forcereload` - Reload the current window ignoring the cache.
|
||||
* `toggledevtools` - Toggle developer tools in the current window
|
||||
* `togglefullscreen`- Toggle full screen mode on the current window
|
||||
* `resetzoom` - Reset the focused page's zoom level to the original size
|
||||
* `zoomin` - Zoom in the focused page by 10%
|
||||
* `zoomout` - Zoom out the focused page by 10%
|
||||
* `editMenu` - Whole default "Edit" menu (Undo, Copy, etc.)
|
||||
* `windowMenu` - Whole default "Window" menu (Minimize, Close, etc.)
|
||||
* `toggledevtools` - Toggle developer tools in the current window.
|
||||
* `togglefullscreen`- Toggle full screen mode on the current window.
|
||||
* `resetzoom` - Reset the focused page's zoom level to the original size.
|
||||
* `zoomin` - Zoom in the focused page by 10%.
|
||||
* `zoomout` - Zoom out the focused page by 10%.
|
||||
* `editMenu` - Whole default "Edit" menu (Undo, Copy, etc.).
|
||||
* `windowMenu` - Whole default "Window" menu (Minimize, Close, etc.).
|
||||
|
||||
The following additional roles are available on macOS:
|
||||
The following additional roles are available on _macOS_:
|
||||
|
||||
* `about` - Map to the `orderFrontStandardAboutPanel` action
|
||||
* `hide` - Map to the `hide` action
|
||||
* `hideothers` - Map to the `hideOtherApplications` action
|
||||
* `unhide` - Map to the `unhideAllApplications` action
|
||||
* `startspeaking` - Map to the `startSpeaking` action
|
||||
* `stopspeaking` - Map to the `stopSpeaking` action
|
||||
* `front` - Map to the `arrangeInFront` action
|
||||
* `zoom` - Map to the `performZoom` action
|
||||
* `toggletabbar` - Map to the `toggleTabBar` action
|
||||
* `selectnexttab` - Map to the `selectNextTab` action
|
||||
* `selectprevioustab` - Map to the `selectPreviousTab` action
|
||||
* `mergeallwindows` - Map to the `mergeAllWindows` action
|
||||
* `movetabtonewwindow` - Map to the `moveTabToNewWindow` action
|
||||
* `window` - The submenu is a "Window" menu
|
||||
* `help` - The submenu is a "Help" menu
|
||||
* `services` - The submenu is a "Services" menu
|
||||
* `recentdocuments` - The submenu is an "Open Recent" menu
|
||||
* `clearrecentdocuments` - Map to the `clearRecentDocuments` action
|
||||
* `about` - Map to the `orderFrontStandardAboutPanel` action.
|
||||
* `hide` - Map to the `hide` action.
|
||||
* `hideothers` - Map to the `hideOtherApplications` action.
|
||||
* `unhide` - Map to the `unhideAllApplications` action.
|
||||
* `startspeaking` - Map to the `startSpeaking` action.
|
||||
* `stopspeaking` - Map to the `stopSpeaking` action.
|
||||
* `front` - Map to the `arrangeInFront` action.
|
||||
* `zoom` - Map to the `performZoom` action.
|
||||
* `toggletabbar` - Map to the `toggleTabBar` action.
|
||||
* `selectnexttab` - Map to the `selectNextTab` action.
|
||||
* `selectprevioustab` - Map to the `selectPreviousTab` action.
|
||||
* `mergeallwindows` - Map to the `mergeAllWindows` action.
|
||||
* `movetabtonewwindow` - Map to the `moveTabToNewWindow` action.
|
||||
* `window` - The submenu is a "Window" menu.
|
||||
* `help` - The submenu is a "Help" menu.
|
||||
* `services` - The submenu is a "Services" menu.
|
||||
* `recentdocuments` - The submenu is an "Open Recent" menu.
|
||||
* `clearrecentdocuments` - Map to the `clearRecentDocuments` action.
|
||||
|
||||
When specifying a `role` on macOS, `label` and `accelerator` are the only
|
||||
options that will affect the menu item. All other options will be ignored.
|
||||
|
|
@ -123,8 +123,8 @@ You can add a `click` function for additional behavior.
|
|||
|
||||
#### `menuItem.label`
|
||||
|
||||
A `String` representing the menu items visible label
|
||||
A `String` representing the menu items visible label.
|
||||
|
||||
#### `menuItem.click`
|
||||
|
||||
A `Function` that is fired when the MenuItem receives a click event
|
||||
A `Function` that is fired when the MenuItem receives a click event.
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ The `menu` object has the following instance methods:
|
|||
|
||||
#### `menu.popup([browserWindow, options])`
|
||||
|
||||
* `browserWindow` BrowserWindow (optional) - Default is the focused window.
|
||||
* `browserWindow` [BrowserWindow](browser-window.md) (optional) - Default is the focused window.
|
||||
* `options` Object (optional)
|
||||
* `x` Number (optional) - Default is the current mouse cursor position.
|
||||
Must be declared if `y` is declared.
|
||||
|
|
@ -71,17 +71,17 @@ The `menu` object has the following instance methods:
|
|||
be positioned under the mouse cursor at the specified coordinates. Default
|
||||
is -1.
|
||||
|
||||
Pops up this menu as a context menu in the `browserWindow`.
|
||||
Pops up this menu as a context menu in the [`BrowserWindow`](browser-window.md).
|
||||
|
||||
#### `menu.closePopup([browserWindow])`
|
||||
|
||||
* `browserWindow` BrowserWindow (optional) - Default is the focused window.
|
||||
* `browserWindow` [BrowserWindow](browser-window.md) (optional) - Default is the focused window.
|
||||
|
||||
Closes the context menu in the `browserWindow`.
|
||||
|
||||
#### `menu.append(menuItem)`
|
||||
|
||||
* `menuItem` MenuItem
|
||||
* `menuItem` [MenuItem](menu-item.md)
|
||||
|
||||
Appends the `menuItem` to the menu.
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ Returns `MenuItem` the item with the specified `id`
|
|||
#### `menu.insert(pos, menuItem)`
|
||||
|
||||
* `pos` Integer
|
||||
* `menuItem` MenuItem
|
||||
* `menuItem` [MenuItem](menu-item.md)
|
||||
|
||||
Inserts the `menuItem` to the `pos` position of the menu.
|
||||
|
||||
|
|
|
|||
|
|
@ -263,7 +263,7 @@ Returns `Boolean` - Whether the image is a template image.
|
|||
|
||||
#### `image.crop(rect)`
|
||||
|
||||
* `rect` [Rectangle](structures/rectangle.md) - The area of the image to crop
|
||||
* `rect` [Rectangle](structures/rectangle.md) - The area of the image to crop.
|
||||
|
||||
Returns `NativeImage` - The cropped image.
|
||||
|
||||
|
|
@ -271,7 +271,7 @@ Returns `NativeImage` - The cropped image.
|
|||
|
||||
* `options` Object
|
||||
* `width` Integer (optional) - Defaults to the image's width.
|
||||
* `height` Integer (optional) - Defaults to the image's height
|
||||
* `height` Integer (optional) - Defaults to the image's height.
|
||||
* `quality` String (optional) - The desired quality of the resize image.
|
||||
Possible values are `good`, `better` or `best`. The default is `best`.
|
||||
These values express a desired quality/speed tradeoff. They are translated
|
||||
|
|
|
|||
|
|
@ -30,15 +30,15 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu
|
|||
### `new Notification([options])` _Experimental_
|
||||
|
||||
* `options` Object
|
||||
* `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown
|
||||
* `subtitle` String (optional) - A subtitle for the notification, which will be displayed below the title. _macOS_
|
||||
* `body` String - The body text of the notification, which will be displayed below the title or subtitle
|
||||
* `silent` Boolean (optional) - Whether or not to emit an OS notification noise when showing the notification
|
||||
* `icon` (String | [NativeImage](native-image.md)) (optional) - An icon to use in the notification
|
||||
* `hasReply` Boolean (optional) - Whether or not to add an inline reply option to the notification. _macOS_
|
||||
* `replyPlaceholder` String (optional) - The placeholder to write in the inline reply input field. _macOS_
|
||||
* `sound` String (optional) - The name of the sound file to play when the notification is shown. _macOS_
|
||||
* `actions` [NotificationAction[]](structures/notification-action.md) (optional) - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_
|
||||
* `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown.
|
||||
* `subtitle` String (optional) _macOS_ - A subtitle for the notification, which will be displayed below the title.
|
||||
* `body` String - The body text of the notification, which will be displayed below the title or subtitle.
|
||||
* `silent` Boolean (optional) - Whether or not to emit an OS notification noise when showing the notification.
|
||||
* `icon` (String | [NativeImage](native-image.md)) (optional) - An icon to use in the notification.
|
||||
* `hasReply` Boolean (optional) _macOS_ - Whether or not to add an inline reply option to the notification.
|
||||
* `replyPlaceholder` String (optional) _macOS_ - The placeholder to write in the inline reply input field.
|
||||
* `sound` String (optional) _macOS_ - The name of the sound file to play when the notification is shown.
|
||||
* `actions` [NotificationAction[]](structures/notification-action.md) (optional) _macOS_ - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation.
|
||||
|
||||
|
||||
### Instance Events
|
||||
|
|
@ -82,7 +82,7 @@ is closed.
|
|||
Returns:
|
||||
|
||||
* `event` Event
|
||||
* `reply` String - The string the user entered into the inline reply field
|
||||
* `reply` String - The string the user entered into the inline reply field.
|
||||
|
||||
Emitted when the user clicks the "Reply" button on a notification with `hasReply: true`.
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ Emitted when the user clicks the "Reply" button on a notification with `hasReply
|
|||
Returns:
|
||||
|
||||
* `event` Event
|
||||
* `index` Number - The index of the action that was activated
|
||||
* `index` Number - The index of the action that was activated.
|
||||
|
||||
### Instance Methods
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The `powerSaveBlocker` module has the following methods:
|
|||
* `prevent-display-sleep` - Prevent the display from going to sleep. Keeps
|
||||
system and screen active. Example use case: playing video.
|
||||
|
||||
Returns `Integer` - The blocker ID that is assigned to this power blocker
|
||||
Returns `Integer` - The blocker ID that is assigned to this power blocker.
|
||||
|
||||
Starts preventing the system from entering lower-power mode. Returns an integer
|
||||
identifying the power save blocker.
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ Returns `Object`:
|
|||
* `privateBytes` Integer - The amount of memory not shared by other processes, such as
|
||||
JS heap or HTML content.
|
||||
* `sharedBytes` Integer - The amount of memory shared between processes, typically
|
||||
memory consumed by the Electron code itself
|
||||
memory consumed by the Electron code itself.
|
||||
|
||||
Returns an object giving memory usage statistics about the current process. Note
|
||||
that all statistics are reported in Kilobytes.
|
||||
|
|
@ -130,10 +130,10 @@ Returns `Object`:
|
|||
system.
|
||||
* `free` Integer - The total amount of memory not being used by applications or disk
|
||||
cache.
|
||||
* `swapTotal` Integer - The total amount of swap memory in Kilobytes available to the
|
||||
system. _Windows_ _Linux_
|
||||
* `swapFree` Integer - The free amount of swap memory in Kilobytes available to the
|
||||
system. _Windows_ _Linux_
|
||||
* `swapTotal` Integer _Windows_ _Linux_ - The total amount of swap memory in Kilobytes available to the
|
||||
system.
|
||||
* `swapFree` Integer _Windows_ _Linux_ - The free amount of swap memory in Kilobytes available to the
|
||||
system.
|
||||
|
||||
Returns an object giving memory usage statistics about the entire system. Note
|
||||
that all statistics are reported in Kilobytes.
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ Callback is invoked with the session's current cache size.
|
|||
|
||||
#### `ses.clearCache(callback)`
|
||||
|
||||
* `callback` Function - Called when operation is done
|
||||
* `callback` Function - Called when operation is done.
|
||||
|
||||
Clears the session’s HTTP cache.
|
||||
|
||||
|
|
@ -113,7 +113,7 @@ Clears the session’s HTTP cache.
|
|||
`scheme://host:port`.
|
||||
* `storages` String[] (optional) - The types of storages to clear, can contain:
|
||||
`appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`,
|
||||
`shadercache`, `websql`, `serviceworkers`
|
||||
`shadercache`, `websql`, `serviceworkers`.
|
||||
* `quotas` String[] (optional) - The types of quotas to clear, can contain:
|
||||
`temporary`, `persistent`, `syncable`.
|
||||
* `callback` Function (optional) - Called when operation is done.
|
||||
|
|
@ -211,7 +211,7 @@ Resolves the proxy information for `url`. The `callback` will be called with
|
|||
|
||||
#### `ses.setDownloadPath(path)`
|
||||
|
||||
* `path` String - The download location
|
||||
* `path` String - The download location.
|
||||
|
||||
Sets download saving directory. By default, the download directory will be the
|
||||
`Downloads` under the respective app folder.
|
||||
|
|
@ -292,7 +292,7 @@ win.webContents.session.setCertificateVerifyProc((request, callback) => {
|
|||
* `permission` String - Enum of 'media', 'geolocation', 'notifications', 'midiSysex',
|
||||
'pointerLock', 'fullscreen', 'openExternal'.
|
||||
* `callback` Function
|
||||
* `permissionGranted` Boolean - Allow or deny the permission
|
||||
* `permissionGranted` Boolean - Allow or deny the permission.
|
||||
|
||||
Sets the handler which can be used to respond to permission requests for the `session`.
|
||||
Calling `callback(true)` will allow the permission and `callback(false)` will reject it.
|
||||
|
|
@ -380,7 +380,7 @@ the initial state will be `interrupted`. The download will start only when the
|
|||
#### `ses.clearAuthCache(options[, callback])`
|
||||
|
||||
* `options` ([RemovePassword](structures/remove-password.md) | [RemoveClientCertificate](structures/remove-client-certificate.md))
|
||||
* `callback` Function (optional) - Called when operation is done
|
||||
* `callback` Function (optional) - Called when operation is done.
|
||||
|
||||
Clears the session’s HTTP authentication cache.
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ The `shell` module has the following methods:
|
|||
|
||||
* `fullPath` String
|
||||
|
||||
Returns `Boolean` - Whether the item was successfully shown
|
||||
Returns `Boolean` - Whether the item was successfully shown.
|
||||
|
||||
Show the given file in a file manager. If possible, select the file.
|
||||
|
||||
|
|
@ -36,11 +36,11 @@ Open the given file in the desktop's default manner.
|
|||
|
||||
### `shell.openExternal(url[, options, callback])`
|
||||
|
||||
* `url` String - max 2081 characters on windows, or the function returns false
|
||||
* `url` String - max 2081 characters on windows, or the function returns false.
|
||||
* `options` Object (optional) _macOS_
|
||||
* `activate` Boolean - `true` to bring the opened application to the
|
||||
foreground. The default is `true`.
|
||||
* `callback` Function (optional) - If specified will perform the open asynchronously. _macOS_
|
||||
* `callback` Function (optional) _macOS_ - If specified will perform the open asynchronously.
|
||||
* `error` Error
|
||||
|
||||
Returns `Boolean` - Whether an application was available to open the URL.
|
||||
|
|
@ -53,7 +53,7 @@ example, mailto: URLs in the user's default mail agent).
|
|||
|
||||
* `fullPath` String
|
||||
|
||||
Returns `Boolean` - Whether the item was successfully moved to the trash
|
||||
Returns `Boolean` - Whether the item was successfully moved to the trash.
|
||||
|
||||
Move the given file to trash and returns a boolean status for the operation.
|
||||
|
||||
|
|
@ -71,7 +71,7 @@ Play the beep sound.
|
|||
exist.
|
||||
* `options` [ShortcutDetails](structures/shortcut-details.md)
|
||||
|
||||
Returns `Boolean` - Whether the shortcut was created successfully
|
||||
Returns `Boolean` - Whether the shortcut was created successfully.
|
||||
|
||||
Creates or updates a shortcut link at `shortcutPath`.
|
||||
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ Removes the subscriber with `id`.
|
|||
* `userInfo` Object
|
||||
|
||||
Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults.
|
||||
This is necessary for events such as `NSUserDefaultsDidChangeNotification`
|
||||
This is necessary for events such as `NSUserDefaultsDidChangeNotification`.
|
||||
|
||||
### `systemPreferences.unsubscribeLocalNotification(id)` _macOS_
|
||||
|
||||
|
|
@ -110,7 +110,7 @@ Same as `unsubscribeNotification`, but removes the subscriber from `NSNotificati
|
|||
|
||||
* `key` String
|
||||
* `type` String - Can be `string`, `boolean`, `integer`, `float`, `double`,
|
||||
`url`, `array`, `dictionary`
|
||||
`url`, `array` or `dictionary`.
|
||||
|
||||
Returns `any` - The value of `key` in `NSUserDefaults`.
|
||||
|
||||
|
|
@ -127,7 +127,7 @@ Some popular `key` and `type`s are:
|
|||
### `systemPreferences.setUserDefault(key, type, value)` _macOS_
|
||||
|
||||
* `key` String
|
||||
* `type` String - See [`getUserDefault`][#systempreferencesgetuserdefaultkey-type-macos]
|
||||
* `type` String - See [`getUserDefault`][#systempreferencesgetuserdefaultkey-type-macos].
|
||||
* `value` String
|
||||
|
||||
Set the value of `key` in `NSUserDefaults`.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Process: [Main](../tutorial/quick-start.md#main-process)
|
|||
* `selectedColor` String (optional) - The selected hex color in the picker,
|
||||
i.e `#ABCDEF`.
|
||||
* `change` Function (optional) - Function to call when a color is selected.
|
||||
* `color` String - The color that the user selected from the picker
|
||||
* `color` String - The color that the user selected from the picker.
|
||||
|
||||
### Instance Properties
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ Process: [Main](../tutorial/quick-start.md#main-process)
|
|||
### `new TouchBarScrubber(options)` _Experimental_
|
||||
|
||||
* `options` Object
|
||||
* `items` [ScrubberItem[]](structures/scrubber-item.md) - An array of items to place in this scrubber
|
||||
* `select` Function - Called when the user taps an item that was not the last tapped item
|
||||
* `selectedIndex` Integer - The index of the item the user selected
|
||||
* `highlight` Function - Called when the user taps any item
|
||||
* `highlightedIndex` Integer - The index of the item the user touched
|
||||
* `items` [ScrubberItem[]](structures/scrubber-item.md) - An array of items to place in this scrubber.
|
||||
* `select` Function - Called when the user taps an item that was not the last tapped item.
|
||||
* `selectedIndex` Integer - The index of the item the user selected.
|
||||
* `highlight` Function - Called when the user taps any item.
|
||||
* `highlightedIndex` Integer - The index of the item the user touched.
|
||||
* `selectedStyle` String - Selected item style. Defaults to `null`.
|
||||
* `overlayStyle` String - Selected overlay item style. Defaults to `null`.
|
||||
* `showArrowButtons` Boolean - Defaults to `false`.
|
||||
|
|
@ -32,9 +32,9 @@ updates the control in the touch bar. Updating deep properties inside this array
|
|||
A `String` representing the style that selected items in the scrubber should have. Updating this value immediately
|
||||
updates the control in the touch bar. Possible values:
|
||||
|
||||
* `background` - Maps to `[NSScrubberSelectionStyle roundedBackgroundStyle]`
|
||||
* `outline` - Maps to `[NSScrubberSelectionStyle outlineOverlayStyle]`
|
||||
* `null` - Actually null, not a string, removes all styles
|
||||
* `background` - Maps to `[NSScrubberSelectionStyle roundedBackgroundStyle]`.
|
||||
* `outline` - Maps to `[NSScrubberSelectionStyle outlineOverlayStyle]`.
|
||||
* `null` - Actually null, not a string, removes all styles.
|
||||
|
||||
#### `touchBarScrubber.overlayStyle`
|
||||
|
||||
|
|
@ -42,9 +42,9 @@ A `String` representing the style that selected items in the scrubber should hav
|
|||
of the scrubber item instead of being placed behind it. Updating this value immediately updates the control in the
|
||||
touch bar. Possible values:
|
||||
|
||||
* `background` - Maps to `[NSScrubberSelectionStyle roundedBackgroundStyle]`
|
||||
* `outline` - Maps to `[NSScrubberSelectionStyle outlineOverlayStyle]`
|
||||
* `null` - Actually null, not a string, removes all styles
|
||||
* `background` - Maps to `[NSScrubberSelectionStyle roundedBackgroundStyle]`.
|
||||
* `outline` - Maps to `[NSScrubberSelectionStyle outlineOverlayStyle]`.
|
||||
* `null` - Actually null, not a string, removes all styles.
|
||||
|
||||
#### `touchBarScrubber.showArrowButtons`
|
||||
|
||||
|
|
@ -56,8 +56,8 @@ immediately updates the control in the touch bar.
|
|||
A `String` representing the mode of this scrubber. Updating this value immediately
|
||||
updates the control in the touch bar. Possible values:
|
||||
|
||||
* `fixed` - Maps to `NSScrubberModeFixed`
|
||||
* `free` - Maps to `NSScrubberModeFree`
|
||||
* `fixed` - Maps to `NSScrubberModeFixed`.
|
||||
* `free` - Maps to `NSScrubberModeFree`.
|
||||
|
||||
#### `touchBarScrubber.continuous`
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Process: [Main](../tutorial/quick-start.md#main-process)
|
|||
* `round-rect` - The control is displayed using the round rect style.
|
||||
* `textured-square` - The control is displayed using the textured square
|
||||
style.
|
||||
* `capsule` - The control is displayed using the capsule style
|
||||
* `capsule` - The control is displayed using the capsule style.
|
||||
* `small-square` - The control is displayed using the small square style.
|
||||
* `separated` - The segments in the control are displayed very close to each
|
||||
other but not touching.
|
||||
|
|
@ -27,7 +27,7 @@ Process: [Main](../tutorial/quick-start.md#main-process)
|
|||
* `buttons` - Make the segments act as buttons, each segment can be pressed and released but never marked as active.
|
||||
* `segments` [SegmentedControlSegment[]](structures/segmented-control-segment.md) - An array of segments to place in this control.
|
||||
* `selectedIndex` Integer (optional) - The index of the currently selected segment, will update automatically with user interaction. When the mode is multiple it will be the last selected item.
|
||||
* `change` Function - Called when the user selects a new segment
|
||||
* `change` Function - Called when the user selects a new segment.
|
||||
* `selectedIndex` Integer - The index of the segment the user selected.
|
||||
* `isSelected` Boolean - Whether as a result of user selection the segment is selected or not.
|
||||
|
||||
|
|
@ -37,15 +37,15 @@ The following properties are available on instances of `TouchBarSegmentedControl
|
|||
|
||||
#### `touchBarSegmentedControl.segmentStyle`
|
||||
|
||||
A `String` representing the controls current segment style. Updating this value immediately updates the control
|
||||
A `String` representing the controls current segment style. Updating this value immediately updates the control
|
||||
in the touch bar.
|
||||
|
||||
#### `touchBarSegmentedControl.segments`
|
||||
|
||||
A `SegmentedControlSegment[]` array representing the segments in this control. Updating this value immediately
|
||||
updates the control in the touch bar. Updating deep properties inside this array **does not update the touch bar**.
|
||||
updates the control in the touch bar. Updating deep properties inside this array **does not update the touch bar**.
|
||||
|
||||
#### `touchBarSegmentedControl.selectedIndex`
|
||||
|
||||
An `Integer` representing the currently selected segment. Changing this value immediately updates the control
|
||||
in the touch bar. User interaction with the touch bar will update this value automatically.
|
||||
in the touch bar. User interaction with the touch bar will update this value automatically.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Process: [Main](../tutorial/quick-start.md#main-process)
|
|||
* `minValue` Integer (optional) - Minimum value.
|
||||
* `maxValue` Integer (optional) - Maximum value.
|
||||
* `change` Function (optional) - Function to call when the slider is changed.
|
||||
* `newValue` Number - The value that the user selected on the Slider
|
||||
* `newValue` Number - The value that the user selected on the Slider.
|
||||
|
||||
### Instance Properties
|
||||
|
||||
|
|
|
|||
|
|
@ -75,8 +75,8 @@ The `Tray` module emits the following events:
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon
|
||||
* `position` [Point](structures/point.md) - The position of the event
|
||||
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon.
|
||||
* `position` [Point](structures/point.md) - The position of the event.
|
||||
|
||||
Emitted when the tray icon is clicked.
|
||||
|
||||
|
|
@ -87,7 +87,7 @@ Emitted when the tray icon is clicked.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon
|
||||
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon.
|
||||
|
||||
Emitted when the tray icon is right clicked.
|
||||
|
||||
|
|
@ -98,7 +98,7 @@ Emitted when the tray icon is right clicked.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon
|
||||
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon.
|
||||
|
||||
Emitted when the tray icon is double clicked.
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ Emitted when dragged files are dropped in the tray icon.
|
|||
#### Event: 'drop-text' _macOS_
|
||||
|
||||
* `event` Event
|
||||
* `text` String - the dropped text string
|
||||
* `text` String - the dropped text string.
|
||||
|
||||
Emitted when dragged text is dropped in the tray icon.
|
||||
|
||||
|
|
@ -152,7 +152,7 @@ Emitted when a drag operation ends on the tray or ends at another location.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `position` [Point](structures/point.md) - The position of the event
|
||||
* `position` [Point](structures/point.md) - The position of the event.
|
||||
|
||||
Emitted when the mouse enters the tray icon.
|
||||
|
||||
|
|
@ -163,7 +163,7 @@ Emitted when the mouse enters the tray icon.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `position` [Point](structures/point.md) - The position of the event
|
||||
* `position` [Point](structures/point.md) - The position of the event.
|
||||
|
||||
Emitted when the mouse exits the tray icon.
|
||||
|
||||
|
|
@ -174,7 +174,7 @@ Emitted when the mouse exits the tray icon.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `position` [Point](structures/point.md) - The position of the event
|
||||
* `position` [Point](structures/point.md) - The position of the event.
|
||||
|
||||
Emitted when the mouse moves in the tray icon.
|
||||
|
||||
|
|
|
|||
|
|
@ -805,7 +805,7 @@ Sends a request to get current zoom factor, the `callback` will be called with
|
|||
|
||||
#### `contents.setZoomLevel(level)`
|
||||
|
||||
* `level` Number - Zoom level
|
||||
* `level` Number - Zoom level.
|
||||
|
||||
Changes the zoom level to the specified level. The original size is 0 and each
|
||||
increment above or below represents zooming 20% larger or smaller to default
|
||||
|
|
@ -945,7 +945,7 @@ console.log(requestId)
|
|||
|
||||
#### `contents.capturePage([rect, ]callback)`
|
||||
|
||||
* `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured
|
||||
* `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured.
|
||||
* `callback` Function
|
||||
* `image` [NativeImage](native-image.md)
|
||||
|
||||
|
|
@ -975,7 +975,7 @@ when the JS promise is rejected.
|
|||
|
||||
Get the system printer list.
|
||||
|
||||
Returns [`PrinterInfo[]`](structures/printer-info.md)
|
||||
Returns [`PrinterInfo[]`](structures/printer-info.md).
|
||||
|
||||
#### `contents.print([options], [callback])`
|
||||
|
||||
|
|
@ -985,7 +985,7 @@ Returns [`PrinterInfo[]`](structures/printer-info.md)
|
|||
the web page. Default is `false`.
|
||||
* `deviceName` String (optional) - Set the printer device name to use. Default is `''`.
|
||||
* `callback` Function (optional)
|
||||
* success` Boolean - Indicates success of the print call.
|
||||
* `success` Boolean - Indicates success of the print call.
|
||||
|
||||
Prints window's web page. When `silent` is set to `true`, Electron will pick
|
||||
the system's default printer if `deviceName` is empty and the default settings
|
||||
|
|
@ -1120,7 +1120,7 @@ send arbitrary arguments. Arguments will be serialized in JSON internally and
|
|||
hence no functions or prototype chain will be included.
|
||||
|
||||
The renderer process can handle the message by listening to `channel` with the
|
||||
`ipcRenderer` module.
|
||||
[`ipcRenderer`](ipc-renderer.md) module.
|
||||
|
||||
An example of sending messages from the main process to the renderer process:
|
||||
|
||||
|
|
@ -1155,17 +1155,17 @@ app.on('ready', () => {
|
|||
|
||||
* `parameters` Object
|
||||
* `screenPosition` String - Specify the screen type to emulate
|
||||
(default: `desktop`)
|
||||
* `desktop` - Desktop screen type
|
||||
* `mobile` - Mobile screen type
|
||||
* `screenSize` [Size](structures/size.md) - Set the emulated screen size (screenPosition == mobile)
|
||||
(default: `desktop`):
|
||||
* `desktop` - Desktop screen type.
|
||||
* `mobile` - Mobile screen type.
|
||||
* `screenSize` [Size](structures/size.md) - Set the emulated screen size (screenPosition == mobile).
|
||||
* `viewPosition` [Point](structures/point.md) - Position the view on the screen
|
||||
(screenPosition == mobile) (default: `{x: 0, y: 0}`)
|
||||
(screenPosition == mobile) (default: `{x: 0, y: 0}`).
|
||||
* `deviceScaleFactor` Integer - Set the device scale factor (if zero defaults to
|
||||
original device scale factor) (default: `0`)
|
||||
original device scale factor) (default: `0`).
|
||||
* `viewSize` [Size](structures/size.md) - Set the emulated view size (empty means no override)
|
||||
* `scale` Float - Scale of emulated view inside available space (not in fit to
|
||||
view mode) (default: `1`)
|
||||
view mode) (default: `1`).
|
||||
|
||||
Enable device emulation with the given parameters.
|
||||
|
||||
|
|
@ -1178,14 +1178,14 @@ Disable device emulation enabled by `webContents.enableDeviceEmulation`.
|
|||
* `event` Object
|
||||
* `type` String (**required**) - The type of the event, can be `mouseDown`,
|
||||
`mouseUp`, `mouseEnter`, `mouseLeave`, `contextMenu`, `mouseWheel`,
|
||||
`mouseMove`, `keyDown`, `keyUp`, `char`.
|
||||
`mouseMove`, `keyDown`, `keyUp` or `char`.
|
||||
* `modifiers` String[] - An array of modifiers of the event, can
|
||||
include `shift`, `control`, `alt`, `meta`, `isKeypad`, `isAutoRepeat`,
|
||||
`leftButtonDown`, `middleButtonDown`, `rightButtonDown`, `capsLock`,
|
||||
`numLock`, `left`, `right`.
|
||||
|
||||
Sends an input `event` to the page.
|
||||
**Note:** The `BrowserWindow` containing the contents needs to be focused for
|
||||
**Note:** The [`BrowserWindow`](browser-window.md) containing the contents needs to be focused for
|
||||
`sendInputEvent()` to work.
|
||||
|
||||
For keyboard events, the `event` object also have following properties:
|
||||
|
|
@ -1198,7 +1198,7 @@ For mouse events, the `event` object also have following properties:
|
|||
|
||||
* `x` Integer (**required**)
|
||||
* `y` Integer (**required**)
|
||||
* `button` String - The button pressed, can be `left`, `middle`, `right`
|
||||
* `button` String - The button pressed, can be `left`, `middle`, `right`.
|
||||
* `globalX` Integer
|
||||
* `globalY` Integer
|
||||
* `movementX` Integer
|
||||
|
|
@ -1218,7 +1218,7 @@ For the `mouseWheel` event, the `event` object also have following properties:
|
|||
|
||||
#### `contents.beginFrameSubscription([onlyDirty ,]callback)`
|
||||
|
||||
* `onlyDirty` Boolean (optional) - Defaults to `false`
|
||||
* `onlyDirty` Boolean (optional) - Defaults to `false`.
|
||||
* `callback` Function
|
||||
* `frameBuffer` Buffer
|
||||
* `dirtyRect` [Rectangle](structures/rectangle.md)
|
||||
|
|
@ -1349,7 +1349,7 @@ Returns `String` - Returns the WebRTC IP Handling Policy.
|
|||
the proxy server supports UDP.
|
||||
|
||||
Setting the WebRTC IP handling policy allows you to control which IPs are
|
||||
exposed via WebRTC. See [BrowserLeaks](https://browserleaks.com/webrtc) for
|
||||
exposed via WebRTC. See [BrowserLeaks](https://browserleaks.com/webrtc) for
|
||||
more details.
|
||||
|
||||
#### `contents.getOSProcessId()`
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Returns `Number` - The current zoom factor.
|
|||
|
||||
### `webFrame.setZoomLevel(level)`
|
||||
|
||||
* `level` Number - Zoom level
|
||||
* `level` Number - Zoom level.
|
||||
|
||||
Changes the zoom level to the specified level. The original size is 0 and each
|
||||
increment above or below represents zooming 20% larger or smaller to default
|
||||
|
|
@ -66,7 +66,7 @@ Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
|
|||
* `language` String
|
||||
* `autoCorrectWord` Boolean
|
||||
* `provider` Object
|
||||
* `spellCheck` Function - Returns `Boolean`
|
||||
* `spellCheck` Function - Returns `Boolean`.
|
||||
* `text` String
|
||||
|
||||
Sets a provider for spell checking in input fields and text areas.
|
||||
|
|
|
|||
|
|
@ -564,7 +564,7 @@ Prints `webview`'s web page as PDF, Same as `webContents.printToPDF(options, cal
|
|||
|
||||
### `<webview>.capturePage([rect, ]callback)`
|
||||
|
||||
* `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured
|
||||
* `rect` [Rectangle](structures/rectangle.md) (optional) - The area of the page to be captured.
|
||||
* `callback` Function
|
||||
* `image` [NativeImage](native-image.md)
|
||||
|
||||
|
|
@ -600,7 +600,7 @@ zoom percent divided by 100, so 300% = 3.0.
|
|||
|
||||
### `<webview>.setZoomLevel(level)`
|
||||
|
||||
* `level` Number - Zoom level
|
||||
* `level` Number - Zoom level.
|
||||
|
||||
Changes the zoom level to the specified level. The original size is 0 and each
|
||||
increment above or below represents zooming 20% larger or smaller to default
|
||||
|
|
|
|||
Loading…
Reference in a new issue