m8-mcp-server 1.0.0

package/dist/data/ejs-doc/api_page/api_page.md

@@ -0,0 +1,261 @@
+# ejs.page
+
+## open
+
+新窗口打开一个页面
+
+注意，新页面会默认读取页面的`title`并设置
+
+非`ejs`环境下是兼容情况，仅剩下打开页面以及传递参数功能，其他配置部分兼容
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |  H5  | 钉钉 | 微信小程序 | 支付宝小程序 | 官方 weex 端 |
+| :------------ | :---------------: | :--: | :--- | :--------- | :----------- | :----------- |
+| 支持          |       支持        | 支持 | 支持 | 支持       | 支持         | 支持         |
+
+**使用示例**
+
+```js
+ejs.page.open({
+    pageUrl: './ejs_demo_v3_simple.html',
+    pageStyle: 1,
+    orientation: 1,
+    // 为1保活状态关闭小程序，为0不保活,默认为0
+    alive: 0,
+    data: {
+        key1: 'value1'
+    },
+    useRouter: true,
+    success: function (result) {
+        /**
+         * 目标页面关闭后会触发这个回调，参数是页面通过close传递过来的参数
+         * {
+                resultData: '可能是json，也可能是普通字符串，要看怎么传参的'
+           }
+         */
+    },
+    error: function (error) {}
+});
+
+// 兼容快速调用
+ejs.page.open('./ejs_demo_v3_simple.html', {
+    key1: 'value1'
+});
+```
+
+使用跨端框架时，传递的参数可在页面生命周期`onLoad`函数（官方 weex 端不支持）中获取：
+
+```js
+export default {
+    onLoad: function (option) {
+        console.log('上个页面的传参：', option);
+    }
+};
+```
+
+**参数说明**
+
+| 参数        |    参数类型     | 说明                                                                                                                                                                                                   |         EJS 原生支持版本          | 平台差异说明                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| :---------- | :-------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| pageUrl     |     String      | 目标页面的地址                                                                                                                                                                                         |                                   | `ejs`、`H5`和`钉钉`环境下，支持`http或https或//`开头的网络路径、`./`或`../`开头的相对路径以及`pages/xxx`开头的绝对路径，绝对路径的方式下要求当前页面必须在`pages`文件夹中(如`pages/a.html`)，否则会计算错误。微信及支付宝等其他小程序平台，只支持在`pages.json`里注册的 vue 页面，`web url`请使用 `web-view组件` 或 uni 框架封装的[uni-link 组件](https://uniapp.dcloud.io/component/uniui/uni-link.html)，官方 weex 端只支持路由页面及其他 weex 页面的跳转 |
+| orientation | Number / String | 不使用路由跳转时，是横屏打开还是竖屏打开，`1`为竖屏，`0`为横屏，默认为`1`,`-1`为跟随系统                                                                                                               |                                   | 仅`ejs`支持                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| pageStyle   | Number / String | 不使用路由跳转时，页面的类型，有多种类型，`1`为默认类型，参考`pageStyle参数说明`                                                                                                                       |                                   | 仅`ejs`支持                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| alive       | Number / String | 为 1 保活状态关闭小程序，为 0 不保活，默认为 0                                                                                                                                                         |                                   | 仅`ejs`支持，新点小程序 2.0 不支持此参数                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| data        |      JSON       | 需要传递的参数，`JSON`键值对形式                                                                                                                                                                       |                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| openStyle   | Number / String | 不使用路由跳转时，打开页面的展示类型，`0` 自右向左侧滑入场，`1` 自底向上冒泡入场，默认为 `0`                                                                                                           | `v7.3 >= 3.2.9.a` `v7.4 >= 3.4.2` | 仅`ejs` 支持                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| useRouter   | Boolean/String  | 针对单页应用，是否使用路由跳转，可选值为布尔值：`true`、 `false`或者字符串：`auto`(`v4.2.2`支持)。</br>非跨端框架默认为 `false`，ejs 环境下及跨端框架默认为`true`</br>当值为`auto`时，与默认值表现相反 |                                   | 仅`ejs`、`h5`及官方 weex 端支持                                                                                                                                                                                                                                                                                                                                                                                                                             |
+
+**常用参数名**
+
+| 参数      | 参数类型        | 说明                                                                                                                                                                               |
+| :-------- | :-------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| pageStyle | Number / String | 不使用路由跳转时，当值为 `-1` 的时候，打开的是隐藏导航栏后的页面类型，当值为 `2` 的时候，打开的是带搜索导航栏类型的页面类型，默认值为 `1` 的时候，打开的是默认导航栏类型的页面类型 |
+
+**支持 URL 后拼接参数控制 EJS 原生页面初始功能**
+
+| 参数                  | 说明（URL 后拼接使用）                                                                                    | EJS 支持版本                        |
+| :-------------------- | :-------------------------------------------------------------------------------------------------------- | :---------------------------------- |
+| ejs_orientation       | 不使用路由跳转时，`-1`打开的页面方向跟随系统，`0` 打开的页面为横屏，`1` 默认打开的页面为竖屏              |                                     |
+| ejs_pagestyle         | 不使用路由跳转时，`-1`打开隐藏导航栏的页面，`2` 打开带搜索导航栏类型的页面，`1` 默认导航栏的页面          |                                     |
+| pageStartVoice        | 不使用路由跳转时，iOS 打开页面时打开语音组件操作，`1`打开，默认不打开。需要配合导航栏带搜索的页面类型使用 |                                     |
+| ejs_nav_bgcolor       | 不使用路由跳转时，控制打开页面时的导航栏颜色，例如 000000。                                               | `>= 3.2.3a`                         |
+| ejs_nav_line          | 不使用路由跳转时，控制打开页面时导航栏下划线显隐，为`0`时隐藏，默认为`1`。                                | `Android >= 3.2.6f; iOS >= 3.2.7b`  |
+| ejs_show_speech       | 不使用路由跳转时，打开页面时打开语音组件操作，`1`打开，默认不打开。需要配合导航栏带搜索的页面类型使用。   | `Android >= 3.2.6.i; iOS >= 3.2.7b` |
+| ejs_pagetitle         | 不使用路由跳转时，支持容器页面打开前设置页面标题                                                          | `>= 3.4.2`                          |
+| ejs_reserve_statusbar | 不使用路由跳转时，是否从状态栏开始渲染页面，0：从状态栏开始渲染，1：不从状态栏渲染                        | `>= 3.4.2`                          |
+| ejs_wv_bgcolor        | 不使用路由跳转时，webview 背景颜色，如：`'4169E1'`                                                        | `>= 3.4.2`                          |
+
+## openLocal
+
+打开应用内原生页面
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+// 示例页面不一定可以打开，仅供参考
+var className = ejs.os.android ? 'com.epoint.demo.view.ComponentCaseActivity' : 'EPTFileSelectViewController';
+
+ejs.page.openLocal({
+    className: className,
+    isOpenExist: 0,
+    data: {
+        key1: 'value1'
+    },
+    success: function (result) {
+        /**
+         * 目标页面关闭后会触发这个回调
+         * 参数需要原生页面主动设置result才能正常返回
+         * {
+                resultData: '可能是json，也可能是普通字符串，要看怎么传参的'
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数        |    参数类型     | 说明                                                                                                                                                                                |
+| :---------- | :-------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| className   |     String      | 页面的类名，`Android`和`iOS`下有差异                                                                                                                                                |
+| isOpenExist | Number / String | 是否打开已经存在的页面并且页面置顶，如果为`1`，会杀掉栈内该页面上面的所有页面(比如有`A->B->C`，如果打开`B`并且设置`1`，那么`A`页面会被杀掉)，默认为`0`, 新点小程序 2.0 不支持此参数 |
+| data        |      JSON       | 需要传递的参数，`JSON`键值对形式，键值对不能再嵌套子`JSON`                                                                                                                          |
+
+**常用参数名**
+
+| 参数      | 参数类型        | 说明                                               |
+| :-------- | :-------------- | :------------------------------------------------- |
+| pageStyle | Number / String | 当值为 `-1` 的时候，打开的是隐藏导航栏后的原生页面 |
+
+**常见类名**
+
+| 原生页面       |   参数   |                 android 类名                  | ios 类名                       |
+| :------------- | :------: | :-------------------------------------------: | :----------------------------- |
+| 通讯录详情页面 | userguid | com.epoint.contact.view.ContactDetailActivity | WPLContactDetailViewController |
+
+## close
+
+关闭页面。
+
+注：M8.2单页应用使用`vue-router`路由跳转的情况下，建议直接使用`vue-router`提供的 API 返回。
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |  H5  | 钉钉 | 微信小程序 | 支付宝小程序 | 官方 weex 端 |
+| :------------ | :---------------: | :--: | :--- | :--------- | :----------- | :----------- |
+| 支持          |       支持        | 支持 | 支持 | 支持       | 支持         | 支持         |
+
+**使用示例**
+
+```js
+ejs.page.close({
+    // 也支持传递字符串
+    resultData: {
+        key: 'value2'
+    },
+    success: function (result) {
+        /**
+         * 回调内请不要做UI显示相关的事情
+         * 因为可能刚回调页面就关闭了
+         */
+    },
+    error: function (error) {}
+});
+
+// 兼容快速调用(快速调用只支持字符串)
+ejs.page.close(JSON.stringify({ key: 'value2' }));
+ejs.page.close('value2');
+```
+
+**参数说明**
+
+| 参数          |    参数类型     | 说明                                                                                                                              | 平台差异说明                                                                                                       |
+| :------------ | :-------------: | :-------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
+| popPageNumber | Number / String | 需要关闭的页面层级，默认为`1`，只会关闭一层                                                                                       | 官方 weex 端仅路由跳转支持                                                                                         |
+| resultData    | String 或 JSON  | 需要传递给上一个页面的数据，可以是`JSON`格式数据或者是普通字符串数据                                                              | 仅`ejs`支持                                                                                                        |
+| useRouter     |     Boolean     | 针对单页应用，是否使用路由返回，可选值为布尔值：`true`、 `false`。</br>非跨端框架默认为 `false`，ejs 环境下及跨端框架默认为`true` | `ejs >= 4.2.2`时仅`ejs`环境下支持，`ejs >= 4.2.5`时`H5`和`ejs`环境都支持，注意使用路由返回时不支持`resultData`参数 |
+
+## reload
+
+重新加载页面
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |  H5  | 钉钉 | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :--: | :--- | :--------- | :----------- |
+| 支持          |       支持        | 支持 | 支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.page.reload();
+```
+
+## showError
+
+显示原生内置的错误提示控件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.page.showError({
+    // 错误类型
+    type: 0,
+    success: function (result) {},
+    error: function (error) {}
+});
+
+// 兼容快速调用
+ejs.page.showError(type);
+```
+
+**参数说明**
+
+| 参数 |    参数类型     | 说明                                                                                    |
+| :--- | :-------------: | :-------------------------------------------------------------------------------------- |
+| type | Number / String | 错误类型，目前支持类型为- `0`: 网络异常 `1`: 服务器异常 `2`: 访问超时 `3`: 页面加载失败 |
+
+## replace
+
+替换当前页面
+
+**平台差异**
+
+| ejs（H5 应用)  |             ejs（新点小程序）              |      H5      | 钉钉         | 微信小程序 | 支付宝小程序 | 官方 weex 端 |
+| :------------- | :----------------------------------------: | :----------: | :----------- | :--------- | :----------- | :----------- |
+| 支持（3.4.3a） | 支持 （3.4.3a）<br>（ejs-weex 环境不支持） | 跨端框架支持 | 跨端框架支持 | 支持       | 支持         | 支持         |
+
+**使用示例**
+
+```js
+ejs.page.replace({
+    // 用来替换的页面地址
+    url: '',
+    success: function (result) {},
+    error: function (error) {}
+});
+
+// 兼容快速调用
+ejs.page.replace(url);
+```
+
+**参数说明**
+
+| 参数      | 参数类型 | 说明                                                                                                                              | 平台差异说明                                                                                                                                                                 |
+| :-------- | :------: | :-------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| url       |  String  | 用来替换的页面地址                                                                                                                | ejs 支持版本：`ejs(Andriod) >= 3.2.10.a` `ejs(iOS) >= 3.2.10`, H5、微信及支付宝等其他小程序平台，只支持在`pages.json`里注册的 vue 页面的替换，官方 weex 端仅支持替换路由页面 |
+| useRouter | Boolean  | 针对单页应用，是否使用路由替换，可选值为布尔值：`true`、 `false`。</br>非跨端框架默认为 `false`，ejs 环境下及跨端框架默认为`true` | `ejs >= 4.2.5`时`H5`和`ejs`环境开始支持                                                                                                                                      |