feat(utils): support replaceTab. (#713)

src/hooks/common/router.ts

@@ -18,12 +18,7 @@ export function useRouterPush(inSetup = true) {
 
   const routerBack = router.back;
 
-  interface RouterPushOptions {
+  async function routerPushByKey(key: RouteKey, options?: App.Global.RouterPushOptions) {
-    query?: Record<string, string>;
-    params?: Record<string, string>;
-  }
-
-  async function routerPushByKey(key: RouteKey, options?: RouterPushOptions) {
     const { query, params } = options || {};
 
     const routeLocation: RouteLocationRaw = {
@@ -67,7 +62,7 @@ export function useRouterPush(inSetup = true) {
   async function toLogin(loginModule?: UnionKey.LoginModule, redirectUrl?: string) {
     const module = loginModule || 'pwd-login';
 
-    const options: RouterPushOptions = {
+    const options: App.Global.RouterPushOptions = {
       params: {
         module
       }

src/store/modules/tab/index.ts

@@ -160,6 +160,25 @@ export const useTabStore = defineStore(SetupStoreId.Tab, () => {
     update();
   }
 
+  const { routerPushByKey } = useRouterPush();
+  /**
+   * Replace tab
+   *
+   * @param key Route key
+   * @param options Router push options
+   */
+  async function replaceTab(key: RouteKey, options?: App.Global.RouterPushOptions) {
+    const oldTabId = activeTabId.value;
+
+    // push new route
+    await routerPushByKey(key, options);
+
+    // remove old tab (exclude fixed tab)
+    if (!isTabRetain(oldTabId)) {
+      await removeTab(oldTabId);
+    }
+  }
+
   /**
    * Switch route by tab
    *
@@ -282,6 +301,7 @@ export const useTabStore = defineStore(SetupStoreId.Tab, () => {
     removeTab,
     removeActiveTab,
     removeTabByRouteName,
+    replaceTab,
     clearTabs,
     clearLeftTabs,
     clearRightTabs,

src/typings/app.d.ts

@@ -175,6 +175,12 @@ declare namespace App {
     type RoutePath = import('@elegant-router/types').RoutePath;
     type LastLevelRouteKey = import('@elegant-router/types').LastLevelRouteKey;
 
+    /** The router push options */
+    type RouterPushOptions = {
+      query?: Record<string, string>;
+      params?: Record<string, string>;
+    };
+
     /** The global header props */
     interface HeaderProps {
       /** Whether to show the logo */