From 0bc8251e1b019cf018e2ffb4d6157db072e25e5f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 16 Jun 2014 14:56:24 +0800 Subject: [PATCH] :memo: Document the web-view module. --- docs/README.md | 1 + docs/api/web-view.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 docs/api/web-view.md diff --git a/docs/README.md b/docs/README.md index 6935853..081e278 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 index 0000000..672830b --- /dev/null +++ b/docs/api/web-view.md @@ -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. -- 2.7.4