mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: type names changed from wrapper to primitive (#31752)

Browse source
This commit is contained in:
Milan Burda 2021-11-16 05:13:18 +01:00 • committed by GitHub
parent 246884c4fb
commit e6b1d95a1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
115 changed files with 1685 additions and 1685 deletions
Download patch file Download diff file Expand all files Collapse all files

48
docs/api/web-frame.md
View file

@ -31,11 +31,11 @@ The factor must be greater than 0.0.
### `webFrame.getZoomFactor()`
Returns `Number` - The current zoom factor.
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
@ -47,12 +47,12 @@ limits of 300% and 50% of original size, respectively.
### `webFrame.getZoomLevel()`
Returns `Number` - The current zoom level.
Returns `number` - The current zoom level.
### `webFrame.setVisualZoomLevelLimits(minimumLevel, maximumLevel)`
* `minimumLevel` Number
* `maximumLevel` Number
* `minimumLevel` number
* `maximumLevel` number
Sets the maximum and minimum pinch-to-zoom level.
@ -69,12 +69,12 @@ Sets the maximum and minimum pinch-to-zoom level.
### `webFrame.setSpellCheckProvider(language, provider)`
* `language` String
* `language` string
* `provider` Object
* `spellCheck` Function
* `words` String[]
* `words` string[]
* `callback` Function
* `misspeltWords` String[]
* `misspeltWords` string[]
Sets a provider for spell checking in input fields and text areas.
@ -112,9 +112,9 @@ webFrame.setSpellCheckProvider('en-US', {
### `webFrame.insertCSS(css)`
* `css` String - CSS source code.
* `css` string - CSS source code.
Returns `String` - A key for the inserted CSS that can later be used to remove
Returns `string` - A key for the inserted CSS that can later be used to remove
the CSS via `webFrame.removeInsertedCSS(key)`.
Injects CSS into the current web page and returns a unique key for the inserted
@ -122,21 +122,21 @@ stylesheet.
### `webFrame.removeInsertedCSS(key)`
* `key` String
* `key` string
Removes the inserted CSS from the current web page. The stylesheet is identified
by its key, which is returned from `webFrame.insertCSS(css)`.
### `webFrame.insertText(text)`
* `text` String
* `text` string
Inserts `text` to the focused element.
### `webFrame.executeJavaScript(code[, userGesture, callback])`
* `code` String
* `userGesture` Boolean (optional) - Default is `false`.
* `code` string
* `userGesture` boolean (optional) - Default is `false`.
* `callback` Function (optional) - Called after script has been executed. Unless
the frame is suspended (e.g. showing a modal alert), execution will be
synchronous and the callback will be invoked before the method returns. For
@ -161,7 +161,7 @@ this limitation.
world used by Electron's `contextIsolation` feature. Accepts values
in the range 1..536870911.
* `scripts` [WebSource[]](structures/web-source.md)
* `userGesture` Boolean (optional) - Default is `false`.
* `userGesture` boolean (optional) - Default is `false`.
* `callback` Function (optional) - Called after script has been executed. Unless
the frame is suspended (e.g. showing a modal alert), execution will be
synchronous and the callback will be invoked before the method returns. For
@ -183,9 +183,9 @@ dispatch errors of isolated worlds to foreign worlds.
* `worldId` Integer - The ID of the world to run the javascript in, `0` is the default world, `999` is the world used by Electrons `contextIsolation` feature. Chrome extensions reserve the range of IDs in `[1 << 20, 1 << 29)`. You can provide any integer here.
* `info` Object
* `securityOrigin` String (optional) - Security origin for the isolated world.
* `csp` String (optional) - Content Security Policy for the isolated world.
* `name` String (optional) - Name for isolated world. Useful in devtools.
* `securityOrigin` string (optional) - Security origin for the isolated world.
* `csp` string (optional) - Content Security Policy for the isolated world.
* `name` string (optional) - Name for isolated world. Useful in devtools.
Set the security origin, content security policy and name of the isolated world.
Note: If the `csp` is specified, then the `securityOrigin` also has to be specified.
@ -240,7 +240,7 @@ and intend to stay there).
### `webFrame.getFrameForSelector(selector)`
* `selector` String - CSS selector for a frame element.
* `selector` string - CSS selector for a frame element.
Returns `WebFrame` - The frame element in `webFrame's` document selected by
`selector`, `null` would be returned if `selector` does not select a frame or
@ -248,7 +248,7 @@ if the frame is not in the current renderer process.
### `webFrame.findFrameByName(name)`
* `name` String
* `name` string
Returns `WebFrame` - A child of `webFrame` with the supplied `name`, `null`
would be returned if there's no such frame or if the frame is not in the current
@ -265,16 +265,16 @@ Returns `WebFrame` - that has the supplied `routingId`, `null` if not found.
### `webFrame.isWordMisspelled(word)`
* `word` String - The word to be spellchecked.
* `word` string - The word to be spellchecked.
Returns `Boolean` - True if the word is misspelled according to the built in
Returns `boolean` - True if the word is misspelled according to the built in
spellchecker, false otherwise. If no dictionary is loaded, always return false.
### `webFrame.getWordSuggestions(word)`
* `word` String - The misspelled word.
* `word` string - The misspelled word.
Returns `String[]` - A list of suggested words for a given word. If the word
Returns `string[]` - A list of suggested words for a given word. If the word
is spelled correctly, the result will be empty.
## Properties