feat(docs): enhance interactive demos and improve documentation

- Add new interactive components for frontend routing, browser rendering pipeline, and database transactions
- Improve existing demos with better visuals, explanations, and examples
- Update documentation structure and content for better clarity
- Add new utility scripts and update package.json with new commands
- Fix formatting and alignment in documentation tables
This commit is contained in:
sanbuphy
2026-02-13 22:10:03 +08:00
parent 599052b2e0
commit d174ceea32
88 changed files with 26273 additions and 15539 deletions
@@ -1,47 +1,81 @@
<template>
<div class="route-guards-demo">
<div class="demo-header">
<h4>路由守卫机制</h4>
<p class="demo-desc">了解全局守卫路由独享守卫和组件内守卫的执行顺序和用途</p>
<span class="icon">🛡</span>
<span class="title">路由守卫</span>
<span class="subtitle">导航流程的安检员</span>
</div>
<div class="guards-container">
<div class="guard-type" v-for="guard in guardTypes" :key="guard.name">
<div class="guard-header" :class="guard.type">
<span class="guard-icon">{{ guard.icon }}</span>
<span class="guard-title">{{ guard.name }}</span>
</div>
<div class="guard-content">
<p class="guard-desc">{{ guard.description }}</p>
<div class="guard-example">
<code>{{ guard.example }}</code>
<div class="intro-text">
想象你在<span class="highlight">机场过安检</span>登机前要检查身份行李登机后可能还要确认信息路由守卫就像这些安检员在导航的各个阶段进行检查和拦截
</div>
<div class="demo-content">
<div class="guards-list">
<div
v-for="guard in guardTypes"
:key="guard.name"
:class="['guard-card', guard.type]"
@click="activeGuard = guard.name"
>
<div class="guard-header">
<span class="guard-icon">{{ guard.icon }}</span>
<span class="guard-name">{{ guard.name }}</span>
</div>
<div class="guard-desc">{{ guard.shortDesc }}</div>
</div>
</div>
<Transition name="fade">
<div v-if="activeGuard" class="guard-detail">
<div class="detail-header">
<span class="detail-icon">{{ currentGuard?.icon }}</span>
<span class="detail-title">{{ currentGuard?.name }}</span>
</div>
<div class="detail-desc">{{ currentGuard?.description }}</div>
<div class="detail-example">
<div class="example-label">💻 代码示例</div>
<pre class="code-block">{{ currentGuard?.example }}</pre>
</div>
</div>
</Transition>
</div>
<div class="execution-flow">
<h5>守卫执行顺序</h5>
<div class="flow-chart">
<div class="flow-step" v-for="(step, index) in executionSteps" :key="index">
<h5>📋 守卫执行顺序</h5>
<div class="flow-steps">
<div
v-for="(step, index) in executionSteps"
:key="index"
class="flow-step"
>
<div class="step-number">{{ index + 1 }}</div>
<div class="step-content">
<div class="step-name">{{ step.name }}</div>
<div class="step-desc">{{ step.description }}</div>
</div>
<div v-if="index < executionSteps.length - 1" class="flow-arrow"></div>
</div>
</div>
</div>
<div class="info-box">
<span class="icon">💡</span>
<strong>核心用途</strong>路由守卫常用于权限验证检查用户是否登录页面预加载获取数据防止误操作离开前提示保存等场景
</div>
</div>
</template>
<script setup>
import { ref, computed } from 'vue'
const activeGuard = ref('beforeEach')
const guardTypes = [
{
name: '全局前置守卫',
name: 'beforeEach',
type: 'global',
icon: '🌍',
shortDesc: '全局前置守卫',
description: '在路由跳转前执行,常用于权限验证、登录检查等',
example: `router.beforeEach((to, from, next) => {
if (to.meta.requiresAuth && !isLoggedIn()) {
@@ -52,233 +86,261 @@ const guardTypes = [
})`
},
{
name: '全局解析守卫',
name: 'beforeResolve',
type: 'global',
icon: '🔍',
shortDesc: '全局解析守卫',
description: '在导航被确认之前、组件内守卫和异步路由组件被解析之后调用',
example: `router.beforeResolve((to, from, next) => {
// 可以在这里做数据预加载
// 数据预加载
next()
})`
},
{
name: '全局后置钩子',
name: 'afterEach',
type: 'global',
icon: '✅',
description: '在导航完成后执行,不接受 next 函数,不能改变导航',
shortDesc: '全局后置钩子',
description: '在导航完成后执行,不能改变导航,常用于页面统计',
example: `router.afterEach((to, from) => {
// 设置页面标题
document.title = to.meta.title || '默认标题'
// 发送页面浏览统计
document.title = to.meta.title
analytics.track(to.path)
})`
},
{
name: '路由独享守卫',
name: 'beforeEnter',
type: 'route',
icon: '🛣️',
shortDesc: '路由独享守卫',
description: '在单个路由配置中定义,只在进入该路由时触发',
example: `{
path: '/admin',
component: Admin,
beforeEnter: (to, from, next) => {
if (!isAdmin()) {
next('/unauthorized')
} else {
next()
}
if (!isAdmin()) next('/unauthorized')
else next()
}
}`
},
{
name: '组件内守卫',
name: 'beforeRouteEnter',
type: 'component',
icon: '🔧',
description: '组件内部定义,可以访问组件实例 this',
example: `export default {
beforeRouteEnter(to, from, next) {
// 在渲染该组件的对应路由被验证前调用
// 不能获取组件实例 this
next(vm => {
// 通过 vm 访问组件实例
})
},
beforeRouteUpdate(to, from, next) {
// 在当前路由改变,但该组件被复用时调用
// 可以访问组件实例 this
this.name = to.params.name
next()
},
beforeRouteLeave(to, from, next) {
// 在导航离开渲染该组件的对应路由时调用
// 可以访问组件实例 this
const answer = window.confirm('确定要离开吗?未保存的更改将丢失。')
if (answer) {
next()
} else {
next(false)
}
}
shortDesc: '组件内守卫-进入',
description: '在渲染该组件的对应路由被验证前调用,不能访问组件实例',
example: `beforeRouteEnter(to, from, next) {
next(vm => {
// 通过 vm 访问组件实例
})
}`
}
]
const executionSteps = [
{
name: '导航触发',
description: '用户点击链接或调用 router.push()'
},
{
name: '组件内 beforeRouteLeave',
description: '在离开的组件中调用,可以取消导航'
},
{
name: '全局 beforeEach',
description: '全局前置守卫,常用于权限检查'
},
{
name: '路由独享 beforeEnter',
description: '在重用的组件中调用'
},
{
name: '组件内 beforeRouteEnter',
description: '在进入新组件前调用,此时组件实例还未创建'
},
{
name: '全局 beforeResolve',
description: '在导航被确认前调用,所有组件内守卫和异步组件已解析'
},
{
name: '全局 afterEach',
description: '导航完成后调用,常用于页面统计、标题设置'
},
{
name: 'DOM 更新',
description: '触发组件更新,渲染新页面'
}
{ name: '触发导航', description: '用户点击链接或调用 router.push()' },
{ name: 'beforeRouteLeave', description: '离开组件的守卫' },
{ name: 'beforeEach', description: '全局前置守卫' },
{ name: 'beforeEnter', description: '路由独享守卫' },
{ name: 'beforeRouteEnter', description: '组件内守卫' },
{ name: 'beforeResolve', description: '全局解析守卫' },
{ name: 'afterEach', description: '全局后置钩子' },
{ name: 'DOM 更新', description: '渲染新页面' }
]
const selectedType = ref('global')
const currentPath = ref('/dashboard')
const currentGuard = computed(() => {
return guardTypes.find(g => g.name === activeGuard.value)
})
</script>
<style scoped>
.route-guards-demo {
padding: 20px;
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
background: var(--vp-c-bg-soft);
border-radius: 12px;
margin: 20px 0;
padding: 1rem;
margin: 1rem 0;
max-height: 600px;
overflow-y: auto;
}
.demo-header {
text-align: center;
margin-bottom: 20px;
display: flex;
align-items: center;
gap: 0.5rem;
margin-bottom: 0.75rem;
}
.demo-header h4 {
margin: 0 0 8px 0;
color: var(--vp-c-text-1);
}
.demo-header .icon { font-size: 1.25rem; }
.demo-header .title { font-weight: bold; font-size: 1rem; }
.demo-header .subtitle { color: var(--vp-c-text-2); font-size: 0.85rem; margin-left: 0.5rem; }
.demo-desc {
margin: 0;
.intro-text {
font-size: 0.9rem;
color: var(--vp-c-text-2);
font-size: 14px;
}
.guards-container {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 16px;
margin-bottom: 24px;
}
.guard-type {
line-height: 1.6;
margin-bottom: 1rem;
padding: 0.75rem;
background: var(--vp-c-bg);
border-radius: 6px;
}
.intro-text .highlight {
color: var(--vp-c-brand-1);
font-weight: 500;
}
.demo-content {
display: flex;
flex-direction: column;
gap: 1rem;
margin-bottom: 1rem;
}
.guards-list {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(140px, 1fr));
gap: 0.75rem;
}
.guard-card {
background: var(--vp-c-bg);
border-radius: 8px;
overflow: hidden;
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
padding: 0.75rem;
cursor: pointer;
transition: all 0.2s;
}
.guard-card:hover {
border-color: var(--vp-c-brand);
transform: translateY(-2px);
}
.guard-card.global {
border-top: 3px solid #667eea;
}
.guard-card.route {
border-top: 3px solid #f5576c;
}
.guard-card.component {
border-top: 3px solid #4facfe;
}
.guard-header {
display: flex;
align-items: center;
gap: 8px;
padding: 12px 16px;
font-weight: 600;
color: white;
}
.guard-header.global {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
}
.guard-header.route {
background: linear-gradient(135deg, #f093fb 0%, #f5576c 100%);
}
.guard-header.component {
background: linear-gradient(135deg, #4facfe 0%, #00f2fe 100%);
gap: 0.5rem;
margin-bottom: 0.5rem;
}
.guard-icon {
font-size: 18px;
font-size: 1rem;
}
.guard-title {
font-size: 14px;
}
.guard-content {
padding: 16px;
.guard-name {
font-size: 0.8rem;
font-weight: 500;
color: var(--vp-c-text-1);
}
.guard-desc {
font-size: 13px;
color: var(--vp-c-text-2);
line-height: 1.5;
margin-bottom: 12px;
font-size: 0.7rem;
color: var(--vp-c-text-3);
}
.guard-example {
.guard-detail {
background: var(--vp-c-bg);
border-radius: 8px;
padding: 1rem;
border: 1px solid var(--vp-c-divider);
}
.detail-header {
display: flex;
align-items: center;
gap: 0.5rem;
margin-bottom: 0.75rem;
}
.detail-icon {
font-size: 1.25rem;
}
.detail-title {
font-size: 0.9rem;
font-weight: 600;
color: var(--vp-c-text-1);
}
.detail-desc {
font-size: 0.85rem;
color: var(--vp-c-text-2);
line-height: 1.5;
margin-bottom: 0.75rem;
}
.detail-example {
background: var(--vp-c-bg-soft);
padding: 0.75rem;
border-radius: 6px;
padding: 12px;
border-left: 3px solid var(--vp-c-brand);
}
.example-label {
font-size: 0.75rem;
font-weight: 500;
color: var(--vp-c-text-2);
margin-bottom: 0.5rem;
}
.code-block {
background: #1e1e1e;
color: #d4d4d4;
padding: 0.5rem;
border-radius: 4px;
font-size: 0.7rem;
line-height: 1.4;
margin: 0;
overflow-x: auto;
}
.guard-example code {
font-family: 'Monaco', 'Menlo', monospace;
font-size: 12px;
color: var(--vp-c-text-1);
line-height: 1.6;
white-space: pre;
.fade-enter-active,
.fade-leave-active {
transition: opacity 0.2s ease, transform 0.2s ease;
}
.fade-enter-from,
.fade-leave-to {
opacity: 0;
transform: translateY(-10px);
}
.execution-flow {
background: var(--vp-c-bg);
border-radius: 8px;
padding: 20px;
padding: 1rem;
border: 1px solid var(--vp-c-divider);
margin-bottom: 1rem;
}
.execution-flow h5 {
margin: 0 0 16px 0;
font-size: 14px;
margin: 0 0 0.75rem 0;
font-size: 0.85rem;
color: var(--vp-c-text-1);
}
.flow-chart {
.flow-steps {
display: flex;
flex-direction: column;
gap: 8px;
gap: 0.5rem;
}
.flow-step {
display: flex;
align-items: center;
gap: 12px;
padding: 10px 12px;
gap: 0.75rem;
padding: 0.5rem 0.75rem;
background: var(--vp-c-bg-soft);
border-radius: 6px;
border-left: 3px solid var(--vp-c-brand);
@@ -293,8 +355,9 @@ const currentPath = ref('/dashboard')
background: var(--vp-c-brand);
color: white;
border-radius: 50%;
font-size: 12px;
font-size: 0.75rem;
font-weight: 600;
flex-shrink: 0;
}
.step-content {
@@ -302,32 +365,30 @@ const currentPath = ref('/dashboard')
}
.step-name {
font-size: 13px;
font-size: 0.8rem;
font-weight: 500;
color: var(--vp-c-text-1);
}
.step-desc {
font-size: 12px;
font-size: 0.7rem;
color: var(--vp-c-text-3);
margin-top: 2px;
margin-top: 0.125rem;
}
.flow-arrow {
text-align: center;
color: var(--vp-c-text-3);
font-size: 14px;
.info-box {
background: var(--vp-c-bg-alt);
padding: 0.75rem;
border-radius: 6px;
font-size: 0.85rem;
color: var(--vp-c-text-2);
}
.info-box .icon { margin-right: 0.25rem; }
@media (max-width: 768px) {
.guards-container {
grid-template-columns: 1fr;
}
.flow-step {
flex-direction: column;
align-items: flex-start;
gap: 8px;
.guards-list {
grid-template-columns: repeat(2, 1fr);
}
}
</style>