:memo: Document the web-view module.
authorCheng Zhao <zcbenz@gmail.com>
Mon, 16 Jun 2014 06:56:24 +0000 (14:56 +0800)
committerCheng Zhao <zcbenz@gmail.com>
Mon, 16 Jun 2014 06:56:24 +0000 (14:56 +0800)
docs/README.md
docs/api/web-view.md [new file with mode: 0644]

index 6935853..081e278 100644 (file)
@@ -26,6 +26,7 @@ Modules for web page:
 
 * [ipc (renderer)](api/ipc-renderer.md)
 * [remote](api/remote.md)
+* [web-view](api/web-view.md)
 
 Modules for both sides:
 
diff --git a/docs/api/web-view.md b/docs/api/web-view.md
new file mode 100644 (file)
index 0000000..672830b
--- /dev/null
@@ -0,0 +1,33 @@
+# web-view
+
+The `web-view` module can custom the rendering of current web page.
+
+An example of zooming current page to 200%.
+
+```javascript
+var webView = require('web-view');
+webView.setZoomFactor(2);
+```
+
+## webView.setZoomFactor(factor)
+
+* `factor` Number - Zoom factor
+
+Changes the zoom factor to the specified factor, zoom factor is
+zoom percent / 100, so 300% = 3.0.
+
+## webView.getZoomFactor()
+
+Returns the current zoom factor.
+
+## webView.setZoomLevel(level)
+
+* `level` Number - Zoom level
+
+Changes the zoom level to the specified level, 0 is "original size", and each
+increment above or below represents zooming 20% larger or smaller to default
+limits of 300% and 50% of original size, respectively.
+
+## webView.getZoomLevel()
+
+Returns the current zoom level.