| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | # webFrame
 | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-09-02 09:57:29 -07:00
										 |  |  | The `web-frame` module allows you to customize the rendering of the current | 
					
						
							| 
									
										
										
										
											2015-08-29 20:05:15 +03:00
										 |  |  | web page. | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | An example of zooming current page to 200%. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```javascript | 
					
						
							| 
									
										
										
										
											2015-11-12 21:20:09 +08:00
										 |  |  | var webFrame = require('electron').webFrame; | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-10-24 18:24:12 +08:00
										 |  |  | webFrame.setZoomFactor(2); | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | ## Methods
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The `web-frame` module has the following methods: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### `webFrame.setZoomFactor(factor)`
 | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | * `factor` Number - Zoom factor. | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-09-02 09:57:29 -07:00
										 |  |  | Changes the zoom factor to the specified factor. Zoom factor is | 
					
						
							|  |  |  | zoom percent divided by 100, so 300% = 3.0. | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | ### `webFrame.getZoomFactor()`
 | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | Returns the current zoom factor. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | ### `webFrame.setZoomLevel(level)`
 | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | * `level` Number - Zoom level | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-31 20:05:57 -07:00
										 |  |  | Changes the zoom level to the specified level. The original size is 0 and each | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | increment above or below represents zooming 20% larger or smaller to default | 
					
						
							|  |  |  | limits of 300% and 50% of original size, respectively. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | ### `webFrame.getZoomLevel()`
 | 
					
						
							| 
									
										
										
										
											2014-06-16 14:56:24 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | Returns the current zoom level. | 
					
						
							| 
									
										
										
										
											2014-12-19 22:34:34 -08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | ### `webFrame.setZoomLevelLimits(minimumLevel, maximumLevel)`
 | 
					
						
							| 
									
										
										
										
											2015-08-27 22:08:25 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | * `minimumLevel` Number | 
					
						
							|  |  |  | * `maximumLevel` Number | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Sets the maximum and minimum zoom level. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | ### `webFrame.setSpellCheckProvider(language, autoCorrectWord, provider)`
 | 
					
						
							| 
									
										
										
										
											2014-12-19 22:34:34 -08:00
										 |  |  | 
 | 
					
						
							|  |  |  | * `language` String | 
					
						
							|  |  |  | * `autoCorrectWord` Boolean | 
					
						
							|  |  |  | * `provider` Object | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Sets a provider for spell checking in input fields and text areas. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The `provider` must be an object that has a `spellCheck` method that returns | 
					
						
							|  |  |  | whether the word passed is correctly spelled. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | An example of using [node-spellchecker][spellchecker] as provider: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```javascript | 
					
						
							| 
									
										
										
										
											2015-11-12 21:20:09 +08:00
										 |  |  | webFrame.setSpellCheckProvider("en-US", true, { | 
					
						
							| 
									
										
										
										
											2014-12-19 22:34:34 -08:00
										 |  |  |   spellCheck: function(text) { | 
					
						
							|  |  |  |     return !(require('spellchecker').isMisspelled(text)); | 
					
						
							|  |  |  |   } | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-13 16:03:40 +08:00
										 |  |  | ### `webFrame.registerURLSchemeAsSecure(scheme)`
 | 
					
						
							| 
									
										
										
										
											2015-01-08 12:37:41 -08:00
										 |  |  | 
 | 
					
						
							|  |  |  | * `scheme` String | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-07-29 16:50:50 +05:30
										 |  |  | Registers the `scheme` as secure scheme. | 
					
						
							| 
									
										
										
										
											2015-01-08 12:37:41 -08:00
										 |  |  | 
 | 
					
						
							|  |  |  | Secure schemes do not trigger mixed content warnings. For example, `https` and | 
					
						
							|  |  |  | `data` are secure schemes because they cannot be corrupted by active network | 
					
						
							|  |  |  | attackers. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-13 16:03:40 +08:00
										 |  |  | ### `webFrame.registerURLSchemeAsBypassingCSP(scheme)`
 | 
					
						
							| 
									
										
										
										
											2015-07-29 16:50:50 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | * `scheme` String | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-08-28 23:20:49 -07:00
										 |  |  | Resources will be loaded from this `scheme` regardless of the current page's | 
					
						
							|  |  |  | Content Security Policy. | 
					
						
							| 
									
										
										
										
											2015-07-29 16:50:50 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-13 16:03:40 +08:00
										 |  |  | ### `webFrame.registerURLSchemeAsPrivileged(scheme)`
 | 
					
						
							| 
									
										
										
										
											2015-09-21 22:59:59 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | * `scheme` String | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-12-29 15:56:19 +05:30
										 |  |  | Registers the `scheme` as secure, bypasses content security policy for resources, | 
					
						
							|  |  |  | allows registering ServiceWorker and supports fetch API. | 
					
						
							| 
									
										
										
										
											2015-09-21 22:59:59 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-01-13 11:21:16 +08:00
										 |  |  | ### `webFrame.insertText(text)`
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | * `text` String | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-01-13 11:55:49 +08:00
										 |  |  | Inserts `text` to the focused element. | 
					
						
							| 
									
										
										
										
											2016-01-13 11:21:16 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-01-13 12:20:49 +08:00
										 |  |  | ### `webFrame.executeJavaScript(code[, userGesture])`
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | * `code` String | 
					
						
							|  |  |  | * `userGesture` Boolean (optional) - Default is `false`. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Evaluates `code` in page. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | In the browser window some HTML APIs like `requestFullScreen` can only be | 
					
						
							|  |  |  | invoked by a gesture from the user. Setting `userGesture` to `true` will remove | 
					
						
							|  |  |  | this limitation. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-12-19 22:34:34 -08:00
										 |  |  | [spellchecker]: https://github.com/atom/node-spellchecker |