Merge pull request #435 from katherine95s/master
docs for new module 'deviceInfo'
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 63a7b49..8bcada9 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -150,6 +150,7 @@
['modules/stream', 'stream'],
['modules/webview', 'webview'],
['modules/websockets', 'webSockets'],
+ ['modules/deviceInfo', 'deviceInfo']
['modules/console-log', 'console-log']
]
},
@@ -323,6 +324,7 @@
['modules/stream', 'stream'],
['modules/webview', 'webview'],
['modules/websockets', 'webSockets'],
+ ['modules/deviceInfo', 'deviceInfo']
['modules/console-log', 'console-log']
]
},
diff --git a/docs/docs/modules/deviceInfo.md b/docs/docs/modules/deviceInfo.md
new file mode 100644
index 0000000..148eba4
--- /dev/null
+++ b/docs/docs/modules/deviceInfo.md
@@ -0,0 +1,33 @@
+# deviceInfo
+
+The `deviceInfo` module can be used to get and set properties about device in weex such as fullScreenHeight.The module is suggested when you create a full screen page.
+
+# API
+
+## enableFullScreenHeight
+
+Since the default screen height in weex may exclude the height of status bar on some full screen devices.`enableFullScreenHeight` can be used to make full screen pages on these devices.
+
+#### enableFullScreenHeight(callback,extend)
+
+* **@callback**, function，callback when complete.
+ * **`fullScreenHeight`**, string, the current full screen height.
+
+* **@extend**, optional parameters，please input {}.
+
+
+#### example
+
+```javascript
+ var deviceInfo = weex.requireModule('deviceInfo')
+ var modal = weex.requireModule('modal')
+ deviceInfo.enableFullScreenHeight(
+ function (e) {
+ modal.toast({
+ message:"full screen height:" + e.fullScreenHeight,
+ duration:1,
+ });
+
+},{});
+```
+[Demo](http://dotwe.org/vue/d164a5f38bc15713e345483ef09868ab)
diff --git a/docs/zh/docs/modules/deviceInfo.md b/docs/zh/docs/modules/deviceInfo.md
new file mode 100644
index 0000000..1144b87
--- /dev/null
+++ b/docs/zh/docs/modules/deviceInfo.md
@@ -0,0 +1,30 @@
+# deviceInfo
+
+deviceInfo模块可用来获取设备的基本信息并进行设置，如fullScreenHeight（全面屏高度）。适配全面屏时建议使用该模块。
+
+# API
+
+## enableFullScreenHeight
+
+适配全面屏时，默认获取的屏幕高度可能不包含status bar的高度，此时建议使用enableFullScreenHeight开启全屏效果
+
+#### enableFullScreenHeight(callback,extend)
+
+* **@callback**, function，用户操作完成后的回调
+ * **`fullScreenHeight`**, string, 全屏高度
+
+* **@extend**, 可选参数 请传入{}
+
+```javascript
+ var deviceInfo = weex.requireModule('deviceInfo')
+ var modal = weex.requireModule('modal')
+ deviceInfo.enableFullScreenHeight(
+ function (e) {
+ modal.toast({
+ message:"full screen height:" + e.fullScreenHeight,
+ duration:1,
+ });
+
+},{});
+```
+[示例](http://dotwe.org/vue/d164a5f38bc15713e345483ef09868ab)
