iframe-tab-sdk 1.0.2 → 1.0.4

package/README.md

@@ -5,12 +5,12 @@ iframe微前端集成, 顶部tab页操作;支持独立运行
 ## API
 |方法名|说明|参数|类型
 |:----|:----|:----|:----
-|openTab|打开tab页|urlPath,openRoute|string,object
-|refreshTab|刷新tab页|urlPath,openRoute|string,object
+|openTab|打开tab页|[openRoute](#openroute-attributes)，详见下表|object
+|refreshTab|刷新tab页|[openRoute](#openroute-attributes)|object
 |closeTab|关闭tab页|urlPath|string
 |logout|退出登录|无|无
 |reload|刷新主应用网页|无|无
-|closeAndOpenTab|关闭当前tab并新开tab|urlPath,{ {...openRoute}, closeTabName }|string,object
+|closeAndOpenTab|关闭当前tab并新开tab|{ [openRoute](#openroute-attributes), closeTabName,message }|object
 |fullscreen|全屏/退出全屏|isFullScreen|boolean
 
 ### openRoute Attributes
@@ -27,7 +27,7 @@ iframe微前端集成, 顶部tab页操作;支持独立运行
 ## 示例(vue+elementui)
 ``` vue
 <template>
-  <el-button type="primary" @click="closeAndOpenTab(urlPath,{...openRoute,closeTabName: '/console/user/add',message:'用户添加成功!' })">关闭当前tab并打开新的tab页</el-button>
+  <el-button type="primary" @click="closeAndOpenTab({openRoute,closeTabName: '/console/user/add',message:'用户添加成功!' })">关闭当前tab并打开新的tab页</el-button>
 </template>
 <script>
 import {closeAndOpenTabAsIframe} from 'iframe-tab-sdk'
@@ -48,4 +48,4 @@ export default {
 }
 </script>
 
-```
+```

package/index.js

@@ -64,15 +64,15 @@ function navigateTo(urlPath, query = {}) {
 
 /**
  * 新开或跳转 tab 标签页
- * @param {Object} params 相关参数
- * @param {String} params[urlPath] 页面地址
+ * @param {String} params 参数
+ * @param {Object} params[urlPath] 页面地址
  * @param {String} params[name] 页面名称
  * @param {String} params[title] 页面标题
  * @param {Object} params[query] query 参数
- * @param {Boolean} params[refreshClearQuery] 是否清空路由参数
  *
  */
-export function openTab(params) {
+export function openTab( params) {
+  const { urlPath, query = {} } = params;
   if (window.isIframeRun) {
     window.parent.postMessage(
       {
@@ -82,7 +82,6 @@ export function openTab(params) {
       origin
     );
   } else {
-    const { urlPath, query = {} } = params;
     // 非iframe环境，执行路由跳转
     navigateTo(urlPath, query);
   }
@@ -90,24 +89,22 @@ export function openTab(params) {
 
 /**
  * 刷新指定 tab 标签页
+ * @param {String} urlPath 指定 tab 标签页 URL
  * @param {Object} params 相关参数
- * @param {String} params[urlPath] 指定 tab 标签页 URL
  * @param {String} params[name] 页面名称
  * @param {String} params[title] 页面标题
  * @param {Object} params[query] query 参数
  */
-export function refreshTab(params) {
-  const urlPath = params.urlPath;
+export function refreshTab(urlPath, params) {
   if (window.isIframeRun) {
     if (params) {
-      return openTab(params);
+      return openTab({...params.urlPath});
     }
-    
     window.parent.postMessage({ type: "refreshTab", params: urlPath }, origin);
   } else {
     // 非iframe环境下，重新导航到指定路径
     if (params) {
-      return openTab(params);
+      return openTab({...params,urlPath});
     }
     navigateTo(urlPath, {});
   }
@@ -156,8 +153,15 @@ export function reload() {
 
 /**
  * 关闭某个tab打开新的tab（常用于关闭自身tab并打开新tab）
+ * @param {Object} params 相关参数
+ * @param {Object} params[openRoute] 跳转的页面信息
+ * @param {String} params[closeTabName] 关闭的页面路由
+ * @param {Object} params[message] 操作完成后的页面提示信息
+ * 
  */
 export function closeAndOpenTab(params) {
+  const { openRoute } = params;
+  
   if (window.isIframeRun) {
     window.parent.postMessage(
       {
@@ -167,9 +171,8 @@ export function closeAndOpenTab(params) {
       origin
     );
   } else {
-    const {urlPath,query} = params;
     // 非iframe环境，直接跳转到新页面
-    navigateTo(urlPath, query);
+    navigateTo(openRoute.urlPath, openRoute.query);
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iframe-tab-sdk",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "门户iframe集成子应用顶部tab页管理",
   "main": "index.js",
   "private": false,
@@ -10,5 +10,5 @@
   },
   "keywords": ["iframe", "tab", "集成", "微前端"],
   "author": "wy",
-  "license": "ISC"
-}
+  "license": "MIT"
+}