From 2c3ed90ff3fafef13046f82dc7cb38761b427fc3 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 23:20:49 -0700 Subject: [PATCH] Standardize web-frame --- docs/api/web-frame.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 810c31a4ecdd..4d42dd78ea50 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -1,45 +1,50 @@ -# web-frame +# webFrame -The `web-frame` module can custom the rendering of current web page. +The `web-frame` module customizes the rendering of the current web page. An example of zooming current page to 200%. ```javascript var webFrame = require('web-frame'); + webFrame.setZoomFactor(2); ``` -## webFrame.setZoomFactor(factor) +## Methods -* `factor` Number - Zoom factor +The `web-frame` module has the following methods: + +### `webFrame.setZoomFactor(factor)` + +* `factor` Number - Zoom factor. Changes the zoom factor to the specified factor, zoom factor is zoom percent / 100, so 300% = 3.0. -## webFrame.getZoomFactor() +### `webFrame.getZoomFactor()` Returns the current zoom factor. -## webFrame.setZoomLevel(level) +### `webFrame.setZoomLevel(level)` * `level` Number - Zoom level -Changes the zoom level to the specified level, 0 is "original size", and each +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 limits of 300% and 50% of original size, respectively. -## webFrame.getZoomLevel() +### `webFrame.getZoomLevel()` Returns the current zoom level. -## webFrame.setZoomLevelLimits(minimumLevel, maximumLevel) +### `webFrame.setZoomLevelLimits(minimumLevel, maximumLevel)` * `minimumLevel` Number * `maximumLevel` Number Sets the maximum and minimum zoom level. -## webFrame.setSpellCheckProvider(language, autoCorrectWord, provider) +### `webFrame.setSpellCheckProvider(language, autoCorrectWord, provider)` * `language` String * `autoCorrectWord` Boolean @@ -60,7 +65,7 @@ require('web-frame').setSpellCheckProvider("en-US", true, { }); ``` -## webFrame.registerUrlSchemeAsSecure(scheme) +### `webFrame.registerUrlSchemeAsSecure(scheme)` * `scheme` String @@ -70,11 +75,11 @@ 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. -## webFrame.registerUrlSchemeAsBypassingCsp(scheme) +### `webFrame.registerUrlSchemeAsBypassingCsp(scheme)` * `scheme` String -Resources will be loaded from this `scheme` regardless of -page's Content Security Policy. +Resources will be loaded from this `scheme` regardless of the current page's +Content Security Policy. [spellchecker]: https://github.com/atom/node-spellchecker