weaver-e10-builder 1.6.13 → 1.6.14

package/skill-docs/references/ebuilder-designer/page-source/sdk-list.md

@@ -0,0 +1,297 @@
+# 列表组件相关
+
+列表数据和选中项由对应列表组件实例提供，不代表整个数据源全部记录。setCheckedDatas(checkedKeys) 用数据 key 数组设置勾选，不接收弹框的 msg、btnText、callback 参数。registerPlugin 示例通过 eventEmitter.once 的 onBeforeMount_<组件ID> 时机注册，不能移到 pageLoad 后假定等价。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `compInstance.getListCurrentData();`：使用此接口可以获取对应的列表组件的数据
+- `compInstance.getCheckedDatas();`：使用此接口可以获取对应的列表组件的选中数据
+- `compInstance.getCheckedIds();`：使用此接口可以获取对应的列表组件的选中数据id
+- `compInstance.getUnCheckedIds();`：使用此接口可以获取对应的列表组件的未选中数据id
+- `compInstance.setCheckedDatas(checkedKeys);`：设置列表勾选的数据 key
+- `compInstance.setAllChecked();`：使用此接口可以设置对应的列表组件的数据全部选中
+- `compInstance.clearChecked();`：使用此接口可以清除对应的列表组件的选中数据
+- `compInstance.getDataSource();`：使用此接口可以获取对应的列表组件的数据源配置
+- `compInstance.refreshBtn();`：使用此接口可以刷新对应列表组件的右上角按钮
+- `compInstance.registerPlugin(plugin);`：使用此接口可以向列表注册插件
+
+## compInstance.getListCurrentData();
+
+使用此接口可以获取对应的列表组件的数据
+
+### 参数说明
+
+无
+
+### 返回值
+
+列表数据
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 获取对应的列表组件的数据 */
+const res = compInstance.getListCurrentData();
+//console.log(res);
+```
+
+
+## compInstance.getCheckedDatas();
+
+使用此接口可以获取对应的列表组件的选中数据
+
+### 参数说明
+无
+
+### 返回值
+选中的列表数据
+
+### 示例
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 获取列表组件被选中的数据 */
+const res = compInstance.getCheckedDatas();
+// console.log(res);
+```
+
+## compInstance.getCheckedIds();
+
+使用此接口可以获取对应的列表组件的选中数据id
+
+### 参数说明
+
+无
+
+### 返回值
+
+选中的列表数据id
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 获取对应的列表组件的选中数据id */
+const res = compInstance.getCheckedIds();
+//console.log(res);
+```
+
+
+## compInstance.getUnCheckedIds();
+
+使用此接口可以获取对应的列表组件的未选中数据id
+
+### 参数说明
+
+无
+
+### 返回值
+
+未选中的列表数据id
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 获取对应的列表组件的未选中数据id */
+const res = compInstance.getUnCheckedIds();
+//console.log(res);
+```
+
+
+## compInstance.setCheckedDatas(checkedKeys);
+
+设置对应列表组件的勾选数据 key。
+
+### 参数说明
+|  参数   | 类型  |  必需   | 说明  |
+|  ----  | ----  |  ----  | ----  |
+| checkedKeys | array | `是`  | 需要选中的数据key |
+
+### 返回值
+
+无
+
+### 示例
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 设置对应的列表组件的选中数据 */
+compInstance.setCheckedDatas(['资源ID_2']);
+```
+
+## compInstance.setAllChecked();
+
+使用此接口可以设置对应的列表组件的数据全部选中
+
+### 参数说明
+
+无
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 设置对应的列表组件的数据全部选中 */
+compInstance.setAllChecked();
+```
+
+
+## compInstance.clearChecked();
+
+使用此接口可以清除对应的列表组件的选中数据
+
+### 参数说明
+
+无
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 清除对应的列表组件的选中数据 */
+compInstance.clearChecked();
+```
+
+
+## compInstance.getDataSource();
+
+使用此接口可以获取对应的列表组件的数据源配置
+
+### 参数说明
+
+无
+
+### 返回值
+
+列表数据源配置
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 获取对应的列表组件的数据源配置 */
+const res = compInstance.getDataSource();
+//console.log(res);
+```
+
+
+## compInstance.refreshBtn();
+
+使用此接口可以刷新对应列表组件的右上角按钮
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| condition     | object   | `否` | 过滤条件                                                             |
+| callback | function | `否` | 刷新完成后的回调函数 |
+
+### 返回值
+
+返回Promise对象
+
+### 示例
+
+```javascript
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 刷新列表组件的右上角按钮 */
+compInstance.refreshBtn();
+
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 刷新列表组件的右上角按钮 */
+compInstance.refreshBtn({}, function(){
+    //刷新完成后的回调
+});
+
+/* 获取列表组件 */
+var compInstance = pageSdk.getCompInstance("组件ID_1");
+/* 刷新列表组件的右上角按钮并替换参数 */
+compInstance.refreshBtn({
+  date: "2022-12-27",
+  name: "张三"
+},function(){
+  //刷新完成后的回调
+});
+```
+
+
+## compInstance.registerPlugin(plugin);
+
+使用此接口可以向列表注册插件
+
+### 参数说明
+ | 参数       | 类型              | 必需 | 说明   |
+ | :------- | :-------------- | :- | :--- |
+ | plugin  | function | 是  | 函数类   |
+ ##### 返回值
+ 无
+ ##### 示例
+ ```typescript
+ import { eventEmitter } from '@weapp/utils';
+ const comId = '组件ID_3'
+ class ExtraPlugin {
+   name = 'ExtraPlugin' // 插件唯一键，必须
+
+   onClick = (e) => {
+     e?.stopPropagation();
+     // xxxxx
+   }
+
+   // 列表式自定义渲染每一行
+   renderListItem = (hook) =>  {
+     return (rowDatas, index, ...args) => {
+       if(index % 2 === 0) {
+         return <div style={{background: 'red'}}>
+           {hook(rowDatas, index, ...args)}
+         </div>
+       }
+       return hook(rowDatas, index, ...args)
+     }
+   }
+
+   // 表格式/列表式自定义渲染单元格
+   renderCell = (hook) => {
+     return (opts, ...args) => {
+       const _opts = {
+         ...opts,
+         data: {
+           ...opts.data,
+           '1': '自定义标题内容'
+         },
+         originValue: opts.field.id === '1' ? '自定义标题内容' : opts.data.originValue,
+         value: opts.field.id === '1' ? '自定义标题内容' : opts.value
+       }
+       return (
+         <div onClick={this.onClick}>
+           <div style={{color: 'red'}}>自定义渲染单元格</div>
+           {hook(_opts, ...args)}
+         </div>
+       )
+     }
+   }
+ }
+
+ eventEmitter.once("@weapp/designer", `onBeforeMount_${comId}`, (plugin) => {
+   plugin.registerPlugin(ExtraPlugin)
+ });
+ ```

package/skill-docs/references/ebuilder-designer/page-source/sdk-native.md

@@ -0,0 +1,193 @@
+# 原生相关
+
+扫码、定位、屏幕、微信及通信能力受客户端、设备权限和宿主环境限制；按具体方法说明选择，不能因 SDK 存在就视为普通 PC 浏览器可用。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `ebSdk.scanQRCode();`：使用此接口可以打开二维码/条形码扫描
+- `ebSdk.getCurrPosition();`：使用此接口可以获取当前位置信息
+- `ebSdk.rotatePage();`：使用此接口可以旋转页面(屏幕)
+- `ebSdk.getWechatUserInfo();`：使用此接口可以获取当前微信用户的信息（仅可在微信或企业微信中使用）
+- `ebSdk.callMobile();`：使用此接口可以拨打电话(含发送短信)
+- `ebSdk.sendMessage(target, msg, success, options);`：使用此接口可以发送信息
+
+## ebSdk.scanQRCode();
+
+使用此接口可以打开二维码/条形码扫描
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                 |
+| -------- | -------- | ---- | -------------------- |
+| callback | function | `是` | 扫码完成后的回调函数 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+ebSdk.scanQRCode(function (result) {
+  /* result：扫码的结果(二维码中存放的信息) */
+});
+```
+
+
+## ebSdk.getCurrPosition();
+
+使用此接口可以获取当前位置信息
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                 |
+| -------- | -------- | ---- | -------------------- |
+| callback | function | `是` | 定位完成后的回调函数 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+ebSdk.getCurrPosition(function (result) {
+  var lng = result['lng']; /* 经度  -- 121.5264300000 */
+  var lat = result['lat']; /* 纬度  -- 31.0800900000 */
+  var addr = result['addr']; /* 中文地址  -- 上海市闵行区联航路1188号 */
+  var province = result['province']; /* 省份 -- 湖北省 */
+  var city = result['city']; /* 城市  -- 武汉市 */
+  var district = result['district']; /* 区  -- 江汉区 */
+  var street = result['street']; /* 街道  -- 长青路 */
+  var streetNumber = result['streetNumber']; /* 街道号码  -- 288号 */
+});
+```
+
+
+## ebSdk.rotatePage();
+
+使用此接口可以旋转页面(屏幕)
+
+### 参数说明
+
+| 参数        | 类型   | 必需 | 说明                         |
+| ----------- | ------ | ---- | ---------------------------- |
+| orientation | number | `是` | 0 竖屏，1 横屏，2 随屏幕转动 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+ebSdk.rotatePage(1); /* 0 竖屏 1 横屏 2 随屏幕转动 */
+```
+
+
+## ebSdk.getWechatUserInfo();
+
+使用此接口可以获取当前微信用户的信息（仅可在微信或企业微信中使用）
+
+### 参数说明
+
+无
+
+### 返回值
+
+返回当前用户的微信信息对象，对象中包含用户微信 openid、昵称、头像 url 等
+
+### 示例
+
+```javascript
+ebSdk.getWechatUserInfo(function (wechatUser) {
+  var openid = wechatUser.openid; //微信用户openid
+  var nickname = wechatUser.nickname; //微信昵称
+  var avatar = wechatUser.avatar; //微信头像url
+});
+```
+
+
+## ebSdk.callMobile();
+
+使用此接口可以拨打电话(含发送短信)
+
+### 参数说明
+
+| 参数 | 类型   | 必需 | 说明                                         |
+| ---- | ------ | ---- | -------------------------------------------- |
+| tel  | string | `是` | 电话号码                                     |
+| type | string | `否` | 类型：拨打电话 tel；发送短信 sms，默认为 tel |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+ebSdk.callMobile('13888888888');
+ebSdk.callMobile('13888888888', 'tel');
+ebSdk.callMobile('13888888888', 'sms');
+```
+
+
+## ebSdk.sendMessage(target, msg, success, options);
+
+使用此接口可以发送信息
+
+### 参数说明
+
+| 参数 | 类型   | 必需 | 说明                                         |
+| ---- | ------ | ---- | -------------------------------------------- |
+| target  | object | `是` | 接收消息的对象信息，可以同时发送给指定的人员、群组、以及创建新的群组并发送，当target值为空时表示发送到当前会话                      |
+| msg | array | `是` | 不同消息类型传递不同参数值 |
+| success | function | `否` | 发送完成后的回调函数 |
+| options | object | `否` | 额外的消息参数，具体以消息可接收的参数为准，此参数内的配置也可覆盖前三个属性 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+const target = { // 接收消息的对象信息，可以同时发送给指定的人员、群组、以及创建新的群组并发送，当target值为空时表示发送到当前会话
+  "toUser": "100,101", // 消息接收人ID，多个用逗号分隔
+  "toGroup": "xxx,xxx", // 接收消息的群组ID，多个用逗号分隔
+  "toExternal": [
+      {
+          "uid":"xxx",
+          "cid":"xxx"
+      },
+      // ...
+  ], // 接收消息的外部联系人列表，其中需要包含人员ID及组织cid
+  "groupMembers": "102,103", // 新创建群组的成员的ID，多个用逗号分隔
+  "groupName": "测试群组", // 新创建群组的名称，如果为空则自动生成默认名称
+}
+const msgList = [
+  // 文本消息
+  {
+    "type": 1,
+    "content": "xxx", // 消息文本内容
+    "atType": 1, // 群组中@类型，1表示@指定人员，2表示@所有人
+    "atUsers": "xxx,xxx" //@指定人员的ID，多个用逗号分隔，暂时不支持@外部人员
+  }
+]
+// 可选参数，可覆盖前三个参数
+const options = {
+    openChat:0, // 发送消息后是否要自动打开对应的聊天界面，只有当接收对象为1个的时候才有效
+    msgObjList: [
+      {
+          // 此参数格式为完整的消息体内容，与消息添加关注时传递给关注接口时的消息体数据一致
+      },
+      // ...
+    ],
+    // target: xxx, msgList: xxx, success: xxx
+}
+ebSdk.sendMessage(target, msgList, function(res) {
+  // 发送消息成功回调
+}, options);
+```

package/skill-docs/references/ebuilder-designer/page-source/sdk-navigation.md

@@ -0,0 +1,156 @@
+# 页面跳转
+
+本章为 SDK 跳转参数，与组合页签 openMode 码表分开。客户端、移动端限定以具体方法说明为准，不把浏览器导航与客户端原生能力混为一谈。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `ebSdk.openPage();`：使用此接口可以打开一个页面
+- `ebSdk.backPage();`：使用此接口可以返回到上一个页面，相当于点击浏览器的后退按钮
+- `ebSdk.backToHomepage();`：使用此接口可以回到首页(应用的第一个页面)，多用于移动端
+- `ebSdk.openWebView();`：使用此接口可以在客户端新开一个WebView窗口来打开指定的页面地址(em中生效，微信中直接跳转页面)
+
+## ebSdk.openPage();
+
+使用此接口可以打开一个页面
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| url     | string   | `是` | 目标页面 ID 或页面地址                                                             |
+| param | object | `否` | 页面参数 |
+| options | object | `否` | 可选参数 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 打开id为资源ID_1的页面 */
+ebSdk.openPage('资源ID_1');
+/* 打开页面时同时传递参数*/
+ebSdk.openPage('资源ID_1', { projectId: '1' });
+/* 使用右侧滑出的方式打开页面 */
+ebSdk.openPage('资源ID_1', {}, { openType: 4 });
+/* 使用右侧滑出的方式打开页面, 同时传递参数 */
+ebSdk.openPage('资源ID_1', { projectId: '1' }, { openType: 4 });
+/* 使用当前布局的方式打开页面, 选择左边栏。 */
+ebSdk.openPage('资源ID_1', {}, { openType:7, layoutType: 'leftSider' });
+/* 移动端使用浮层页面的方式打开页面 */
+ebSdk.openPage('资源ID_1', {}, { openType: '8'  });
+/* 移动端使用浮层页面的方式打开url页面 */
+ebSdk.openPage('https://www.baidu.com', {}, { openType: '8'  });
+/* 移动端使用新的webview窗口的方式打开页面 */
+ebSdk.openPage('资源ID_1', {}, { openType: '9'  });
+/* 移动端使用路由跳转的方式打开页面 */
+ebSdk.openPage('资源ID_1', {}, { openType: '10'  });
+/* 打开方式 openType:当前页面 1 ；新窗口 2 ；弹出窗口 3 ；右侧滑出 4 ；重定向 5 ；右侧推出 6 ；当前布局 7；浮层页面 8；新的webview窗口：9；路由跳转：10； */
+
+/* 选择布局 layoutType:中间栏：main；左边栏：leftSider；右边栏：rightSider；上边栏：topSider；下边栏：bottomSider； */
+
+// 设置页面标题和页面图标
+ebSdk.openPage('资源ID_2', {}, {
+  openType: 3,
+  isBlankClose: false,  // 点击遮罩或空白处关闭  默认为 true
+  modalHeight: '400px', // 窗口高度  弹出窗口时（openType=3）设置弹窗高度可以生效
+  modalWidth: '600px',  // 窗口宽度
+  pageTitle: '标题',  // 页面标题
+  pageIcon: 'Icon-Mongo-database', // 页面图标  可设置图标名称（图标库地址 https://weapp.eteams.cn/iconfont）、图片路径
+  // 如果要自定义图标样式，pageIcon 设置方式如下：
+  // pageIcon: {
+  //   path: "Icon-Mongo-database", // 页面图标
+  //   style: { // 自定义图标样式
+  //       "bgColor": "#65C8D0",
+  //       "color": "#ffffff",
+  //       "radius": "3px"
+  //   }
+  // }
+});
+
+// 打开系统弹窗回刷，文档：https://weapp.eteams.cn/build/techdoc/wdoc/index.html#/public/doc/c3d3928e-48fb-4a66-8efd-237dde4aa142
+ebSdk.openPage(
+  'systempage/newbusinessformdata',
+  {
+    xxx: 'xxxx',
+    // xxxx
+  },
+  {
+    openType: 2, // 新窗口方式打开
+    // isBlankClose: false, /** 是否空白处关闭弹窗 */;
+    // modalWidth: '800px', /** 弹窗宽度 */;
+    // modalHeight?: '600px' /** 弹窗高度 */;
+  },
+  () => {
+    console.log('触发自定义回调')
+  }
+)
+```
+
+## ebSdk.backPage();
+
+使用此接口可以返回到上一个页面，相当于点击浏览器的后退按钮
+
+### 参数说明
+
+无
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+ebSdk.backPage(); //返回到上一个页面
+```
+
+
+## ebSdk.backToHomepage();
+
+使用此接口可以回到首页(应用的第一个页面)，多用于移动端
+
+### 参数说明
+
+无
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+ebSdk.backToHomepage(); // 回到首页面
+```
+
+
+## ebSdk.openWebView();
+
+使用此接口可以在客户端新开一个WebView窗口来打开指定的页面地址(em中生效，微信中直接跳转页面)
+
+### 参数说明
+
+| 参数   | 类型   | 必需 | 说明                               |
+| ------ | ------ | ---- | ---------------------------------- |
+| url    | string | `是` | 页面地址                           |
+| config | object | `否` | 详细配置，见示例(app 客户端中生效) |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/*外部地址*/
+ebSdk.openWebView('https://www.baidu.com');
+
+/*内部地址*/
+ebSdk.openWebView('/mobile/ebdpage/view/资源ID_3', {
+  title: '新的页面', //页面标题
+});
+```