feat: add the attribute routeCached to route to control cache the DOM corresponding to the route

This commit is contained in:
Jin Mao
2026-02-27 16:04:01 +08:00
parent 45b843f344
commit bd22793ceb
9 changed files with 301 additions and 83 deletions

View File

@@ -1,17 +1,15 @@
<script lang="ts" setup>
import type { VNode } from 'vue';
import type {
RouteLocationNormalizedLoaded,
RouteLocationNormalizedLoadedGeneric,
} from 'vue-router';
import type { RouteLocationNormalizedLoadedGeneric } from 'vue-router';
import { computed } from 'vue';
import { unref } from 'vue';
import { RouterView } from 'vue-router';
import { preferences, usePreferences } from '@vben/preferences';
import { usePreferences } from '@vben/preferences';
import { getTabKey, storeToRefs, useTabbarStore } from '@vben/stores';
import { transformComponent, useLayoutHook } from '../../hooks';
import { IFrameRouterView } from '../../iframe';
import { RouteCachedPage, RouteCachedView } from '../../route-cached';
defineOptions({ name: 'LayoutContent' });
@@ -21,85 +19,27 @@ const { keepAlive } = usePreferences();
const { getCachedTabs, getExcludeCachedTabs, renderRouteView } =
storeToRefs(tabbarStore);
/**
* 是否使用动画
*/
const getEnabledTransition = computed(() => {
const { transition } = preferences;
const transitionName = transition.name;
return transitionName && transition.enable;
});
// 页面切换动画
function getTransitionName(_route: RouteLocationNormalizedLoaded) {
// 如果偏好设置未设置,则不使用动画
const { tabbar, transition } = preferences;
const transitionName = transition.name;
if (!transitionName || !transition.enable) {
return;
}
// 标签页未启用或者未开启缓存,则使用全局配置动画
if (!tabbar.enable || !keepAlive) {
return transitionName;
}
// 如果页面已经加载过,则不使用动画
// if (route.meta.loaded) {
// return;
// }
// 已经打开且已经加载过的页面不使用动画
// const inTabs = getCachedTabs.value.includes(route.name as string);
// return inTabs && route.meta.loaded ? undefined : transitionName;
return transitionName;
}
const { getEnabledTransition, getTransitionName } = useLayoutHook();
/**
* 转换组件,自动添加 name
* @param component
* 是否显示component
* @param route
*/
function transformComponent(
component: VNode,
route: RouteLocationNormalizedLoadedGeneric,
) {
// 组件视图未找到,如果有设置后备视图,则返回后备视图,如果没有,则抛出错误
if (!component) {
console.error(
'Component view not foundplease check the route configuration',
);
return undefined;
}
const routeName = route.name as string;
// 如果组件没有 name则直接返回
if (!routeName) {
return component;
}
const componentName = (component?.type as any)?.name;
// 已经设置过 name则直接返回
if (componentName) {
return component;
}
// componentName 与 routeName 一致,则直接返回
if (componentName === routeName) {
return component;
}
// 设置 name
component.type ||= {};
(component.type as any).name = routeName;
return component;
}
const showComponent = (route: RouteLocationNormalizedLoadedGeneric) => {
return !route.meta.domCached && unref(renderRouteView);
};
</script>
<template>
<div class="relative h-full">
<IFrameRouterView />
<RouteCachedView />
<RouterView v-slot="{ Component, route }">
<RouteCachedPage
:component="Component"
:route="route"
v-if="route.meta.domCached"
/>
<Transition
v-if="getEnabledTransition"
:name="getTransitionName(route)"
@@ -113,14 +53,14 @@ function transformComponent(
>
<component
:is="transformComponent(Component, route)"
v-if="renderRouteView"
v-if="showComponent(route)"
v-show="!route.meta.iframeSrc"
:key="getTabKey(route)"
/>
</KeepAlive>
<component
:is="Component"
v-else-if="renderRouteView"
v-else-if="showComponent(route)"
:key="getTabKey(route)"
/>
</Transition>
@@ -132,14 +72,14 @@ function transformComponent(
>
<component
:is="transformComponent(Component, route)"
v-if="renderRouteView"
v-if="showComponent(route)"
v-show="!route.meta.iframeSrc"
:key="getTabKey(route)"
/>
</KeepAlive>
<component
:is="Component"
v-else-if="renderRouteView"
v-else-if="showComponent(route)"
:key="getTabKey(route)"
/>
</template>