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,93 +1,126 @@
<template>
<div class="component-hierarchy-demo">
<div class="demo-header">
<h4>组件层级可视化</h4>
<p class="hint">点击组件查看详情观察组件树如何组织</p>
<span class="icon">🌳</span>
<span class="title">组件层级结构</span>
<span class="subtitle">像家谱树一样的组件关系</span>
</div>
<div class="tree-container">
<div class="tree-node root-node" :class="{ active: selectedNode === 'app' }" @click="selectNode('app')">
<div class="node-icon">🌳</div>
<div class="node-label">App (根组件)</div>
<div class="node-desc">管理全局状态</div>
</div>
<div class="intro-text">
想象你在<span class="highlight">公司组织架构</span>工作CEO根组件在顶层下面是各个部门父组件每个部门里还有员工子组件这就是组件树
</div>
<div class="tree-children">
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'header' }" @click="selectNode('header')">
<div class="node-icon">📌</div>
<div class="node-label">Header</div>
<div class="node-desc">导航 + 用户信息</div>
<div class="demo-content">
<div class="tree-container">
<div class="tree-node root-node" :class="{ active: selectedNode === 'app' }" @click="selectNode('app')">
<div class="node-icon">👑</div>
<div class="node-info">
<div class="node-label">App (根组件)</div>
<div class="node-desc">CEO - 管理全局</div>
</div>
</div>
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'main' }" @click="selectNode('main')">
<div class="node-icon">📄</div>
<div class="node-label">Main Content</div>
<div class="node-desc">页面主要内容</div>
<div class="tree-children">
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'header' }" @click="selectNode('header')">
<div class="node-icon">📌</div>
<div class="node-info">
<div class="node-label">Header</div>
<div class="node-desc">导航栏部门</div>
</div>
</div>
</div>
<div class="tree-children">
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'sidebar' }" @click="selectNode('sidebar')">
<div class="node-icon">📑</div>
<div class="node-label">Sidebar</div>
<div class="node-desc">侧边栏菜单</div>
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'main' }" @click="selectNode('main')">
<div class="node-icon">📄</div>
<div class="node-info">
<div class="node-label">Main Content</div>
<div class="node-desc">主内容部门</div>
</div>
</div>
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'productlist' }" @click="selectNode('productlist')">
<div class="node-icon">🛍</div>
<div class="node-label">ProductList</div>
<div class="node-desc">商品列表展示</div>
<div class="tree-children">
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'sidebar' }" @click="selectNode('sidebar')">
<div class="node-icon">📑</div>
<div class="node-info">
<div class="node-label">Sidebar</div>
<div class="node-desc">侧边栏小组</div>
</div>
</div>
</div>
<div class="tree-children">
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node leaf" :class="{ active: selectedNode === 'productcard' }" @click="selectNode('productcard')">
<div class="node-icon">🏷</div>
<div class="node-label">ProductCard</div>
<div class="node-desc">单个商品卡片</div>
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'productlist' }" @click="selectNode('productlist')">
<div class="node-icon">🛍</div>
<div class="node-info">
<div class="node-label">ProductList</div>
<div class="node-desc">商品列表组</div>
</div>
</div>
<div class="tree-children">
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node leaf" :class="{ active: selectedNode === 'productcard' }" @click="selectNode('productcard')">
<div class="node-icon">🏷</div>
<div class="node-info">
<div class="node-label">ProductCard</div>
<div class="node-desc">商品卡片员工</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'footer' }" @click="selectNode('footer')">
<div class="node-icon">🔻</div>
<div class="node-label">Footer</div>
<div class="node-desc">页脚信息</div>
<div class="tree-branch">
<div class="connector"></div>
<div class="tree-node" :class="{ active: selectedNode === 'footer' }" @click="selectNode('footer')">
<div class="node-icon">🔻</div>
<div class="node-info">
<div class="node-label">Footer</div>
<div class="node-desc">页脚部门</div>
</div>
</div>
</div>
</div>
</div>
<Transition name="fade">
<div v-if="selectedNodeInfo" class="node-details">
<div class="detail-header">
<span class="detail-icon">{{ selectedNodeInfo.icon }}</span>
<span class="detail-title">{{ selectedNodeInfo.title }}</span>
</div>
<p class="detail-desc">{{ selectedNodeInfo.description }}</p>
<div v-if="selectedNodeInfo.props || selectedNodeInfo.events" class="detail-info">
<div v-if="selectedNodeInfo.props" class="info-section">
<strong>📥 接收:</strong>
<span class="prop-tags">{{ selectedNodeInfo.props.join(', ') }}</span>
</div>
<div v-if="selectedNodeInfo.events" class="info-section">
<strong>📤 触发:</strong>
<span class="prop-tags">{{ selectedNodeInfo.events.join(', ') }}</span>
</div>
</div>
</div>
</Transition>
<div v-if="!selectedNode" class="hint-text">
👆 点击上方任意节点查看职责说明
</div>
</div>
<div v-if="selectedNodeInfo" class="node-details">
<h5>{{ selectedNodeInfo.title }}</h5>
<p>{{ selectedNodeInfo.description }}</p>
<div class="props-list" v-if="selectedNodeInfo.props">
<strong>接收的 Props:</strong>
<ul>
<li v-for="prop in selectedNodeInfo.props" :key="prop">{{ prop }}</li>
</ul>
</div>
<div class="events-list" v-if="selectedNodeInfo.events">
<strong>触发的事件:</strong>
<ul>
<li v-for="event in selectedNodeInfo.events" :key="event">{{ event }}</li>
</ul>
</div>
<div class="info-box">
<span class="icon">💡</span>
<strong>核心思想</strong>组件像组织架构父组件管理整体子组件负责具体功能数据从上往下传事件从下往上报
</div>
</div>
</template>
@@ -99,44 +132,51 @@ const selectedNode = ref(null)
const nodeInfoMap = {
app: {
title: 'App (根组件)',
description: '应用的入口组件,负责初始化全局状态、路由配置和全局样式。通常包含 RouterView 来渲染页面级组件',
icon: '👑',
title: 'App 根组件',
description: '就像公司的CEO,负责整个应用的初始化和全局管理。包含路由、全局状态、主题配置等大方向决策。',
props: [],
events: []
},
header: {
title: 'Header (导航栏)',
description: '顶部导航组件,显示 Logo、主导航菜单、用户信息、购物车入口等。通常是全局组件,在大多数页面都显示。',
icon: '📌',
title: 'Header 导航栏',
description: '公司的前台部门,负责展示Logo、导航菜单、用户信息和购物车等。大部分页面都会用到它。',
props: ['user', 'cartCount'],
events: ['logout', 'search']
},
main: {
title: 'Main Content (主内容区)',
description: '页面的主要内容区域,包含侧边栏和具体内容。使用 flex 或 grid 布局来组织内容',
icon: '📄',
title: 'Main Content 主内容',
description: '公司的核心业务部门,管理页面的主要内容区域。用flex或grid布局组织侧边栏和内容。',
props: [],
events: []
},
sidebar: {
title: 'Sidebar (侧边栏)',
description: '左侧导航菜单,通常用于后台管理系统或分类浏览页面。包含可折叠的菜单组。',
icon: '📑',
title: 'Sidebar 侧边栏',
description: '公司的导航小组,提供可折叠的菜单。常见于后台管理系统或分类浏览页面。',
props: ['menuItems', 'collapsed'],
events: ['select', 'toggle']
},
productlist: {
title: 'ProductList (商品列表)',
description: '展示商品列表的容器组件,负责数据获取、分页、排序和筛选逻辑。包含多个 ProductCard 组件。',
icon: '🛍️',
title: 'ProductList 商品列表',
description: '商品展示团队,负责数据获取、分页、排序和筛选。包含多个ProductCard成员。',
props: ['products', 'loading', 'total'],
events: ['loadMore', 'sort', 'filter']
},
productcard: {
title: 'ProductCard (商品卡片)',
description: '单个商品的展示卡片,显示商品图片、名称、价格、评分等信息。是最基础的 UI 组件之一。',
icon: '🏷️',
title: 'ProductCard 商品卡片',
description: '最基层的员工,负责展示单个商品的信息(图片、名称、价格、评分)。专注于UI展示。',
props: ['product', 'showAddToCart'],
events: ['addToCart', 'click']
},
footer: {
title: 'Footer (页脚)',
description: '页面底部的信息区域,包含版权信息、友情链接、联系方式、社交媒体链接等。',
icon: '🔻',
title: 'Footer 页脚',
description: '公司的后勤部门,展示版权信息、友情链接、联系方式、社交媒体链接等辅助信息。',
props: [],
events: []
}
@@ -147,7 +187,7 @@ const selectedNodeInfo = computed(() => {
})
const selectNode = (nodeId) => {
selectedNode.value = nodeId
selectedNode.value = selectedNode.value === nodeId ? null : nodeId
}
</script>
@@ -155,50 +195,81 @@ const selectNode = (nodeId) => {
.component-hierarchy-demo {
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
padding: 20px;
background: var(--vp-c-bg-soft);
padding: 1rem;
margin: 1rem 0;
max-height: 600px;
overflow-y: auto;
}
.demo-header {
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;
}
.hint {
margin: 0;
font-size: 14px;
.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;
}
.intro-text {
font-size: 0.9rem;
color: var(--vp-c-text-2);
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 {
background: var(--vp-c-bg);
border-radius: 6px;
padding: 1rem;
margin-bottom: 0.75rem;
}
.tree-container {
overflow-x: auto;
padding: 10px 0;
}
.tree-children {
display: flex;
flex-direction: column;
gap: 12px;
margin-top: 12px;
margin-left: 28px;
gap: 0.75rem;
margin-top: 0.75rem;
margin-left: 1.5rem;
}
.tree-branch {
position: relative;
display: flex;
align-items: flex-start;
gap: 12px;
gap: 0.75rem;
}
.connector {
width: 20px;
width: 16px;
height: 2px;
background: var(--vp-c-divider);
margin-top: 24px;
margin-top: 18px;
position: relative;
}
@@ -206,22 +277,22 @@ const selectNode = (nodeId) => {
content: '';
position: absolute;
left: 0;
top: -10px;
top: -8px;
width: 2px;
height: 12px;
height: 10px;
background: var(--vp-c-divider);
}
.tree-node {
display: flex;
align-items: center;
gap: 10px;
padding: 12px 16px;
background: var(--vp-c-bg);
gap: 0.75rem;
padding: 0.75rem 1rem;
background: var(--vp-c-bg-soft);
border: 2px solid var(--vp-c-divider);
border-radius: 8px;
cursor: pointer;
transition: all 0.3s ease;
transition: all 0.2s ease;
min-width: 180px;
}
@@ -233,7 +304,7 @@ const selectNode = (nodeId) => {
.tree-node.active {
border-color: var(--vp-c-brand);
background: var(--vp-c-brand-soft);
box-shadow: 0 0 0 3px var(--vp-c-brand-soft);
box-shadow: 0 0 0 3px var(--vp-c-brand-delta);
}
.root-node {
@@ -243,105 +314,129 @@ const selectNode = (nodeId) => {
.leaf .node-icon {
opacity: 0.8;
transform: scale(0.9);
}
.node-icon {
font-size: 20px;
font-size: 1.25rem;
display: flex;
align-items: center;
justify-content: center;
width: 32px;
height: 32px;
background: var(--vp-c-bg-soft);
background: var(--vp-c-bg);
border-radius: 6px;
}
.node-info {
display: flex;
flex-direction: column;
}
.node-label {
font-weight: 600;
font-size: 14px;
font-size: 0.875rem;
color: var(--vp-c-text-1);
}
.node-desc {
font-size: 12px;
font-size: 0.75rem;
color: var(--vp-c-text-2);
margin-left: auto;
padding-left: 12px;
border-left: 1px solid var(--vp-c-divider);
margin-top: 0.15rem;
}
.node-details {
margin-top: 20px;
padding: 16px;
background: var(--vp-c-bg);
margin-top: 1rem;
padding: 1rem;
background: var(--vp-c-bg-soft);
border-radius: 6px;
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
animation: slideIn 0.3s ease;
}
@keyframes slideIn {
from {
opacity: 0;
transform: translateY(-10px);
}
to {
opacity: 1;
transform: translateY(0);
}
.detail-header {
display: flex;
align-items: center;
gap: 0.5rem;
margin-bottom: 0.5rem;
}
.node-details h5 {
margin: 0 0 8px 0;
color: var(--vp-c-brand);
font-size: 16px;
.detail-icon {
font-size: 1.25rem;
}
.node-details p {
margin: 0 0 12px 0;
color: var(--vp-c-text-2);
font-size: 14px;
line-height: 1.6;
}
.props-list, .events-list {
margin-top: 12px;
}
.props-list strong, .events-list strong {
display: block;
margin-bottom: 4px;
.detail-title {
font-weight: 600;
font-size: 0.9rem;
color: var(--vp-c-text-1);
font-size: 13px;
}
.props-list ul, .events-list ul {
margin: 0;
padding-left: 20px;
}
.props-list li, .events-list li {
.detail-desc {
font-size: 0.875rem;
color: var(--vp-c-text-2);
font-size: 13px;
line-height: 1.5;
margin-bottom: 0.75rem;
}
.detail-info {
display: flex;
flex-direction: column;
gap: 0.5rem;
}
.info-section {
display: flex;
align-items: center;
gap: 0.5rem;
font-size: 0.8rem;
}
.info-section strong {
color: var(--vp-c-text-1);
flex-shrink: 0;
}
.prop-tags {
color: var(--vp-c-brand);
font-family: monospace;
margin: 2px 0;
font-size: 0.75rem;
}
.hint-text {
text-align: center;
font-size: 0.85rem;
color: var(--vp-c-text-3);
margin-top: 0.75rem;
}
.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);
}
.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) {
.tree-node {
min-width: auto;
flex-wrap: wrap;
}
.node-desc {
width: 100%;
margin-top: 4px;
padding-left: 42px;
border-left: none;
}
.tree-children {
margin-left: 16px;
margin-left: 1rem;
}
}
</style>