feat(theme): add doc aside scroll spy

pull/4457/head
userquin 9 months ago
parent 38a755e365
commit d6a5c13229

@ -1,6 +1,6 @@
<script setup lang="ts"> <script setup lang="ts">
import { useRoute } from 'vitepress' import { useRoute } from 'vitepress'
import { computed } from 'vue' import { computed, nextTick, provide, ref } from 'vue'
import { useData } from '../composables/data' import { useData } from '../composables/data'
import { useSidebar } from '../composables/sidebar' import { useSidebar } from '../composables/sidebar'
import VPDocAside from './VPDocAside.vue' import VPDocAside from './VPDocAside.vue'
@ -10,10 +10,18 @@ const { theme } = useData()
const route = useRoute() const route = useRoute()
const { hasSidebar, hasAside, leftAside } = useSidebar() const { hasSidebar, hasAside, leftAside } = useSidebar()
const asideContainerRef = ref<HTMLDivElement | undefined>()
const pageName = computed(() => const pageName = computed(() =>
route.path.replace(/[./]+/g, '_').replace(/_html$/, '') route.path.replace(/[./]+/g, '_').replace(/_html$/, '')
) )
function scrollAside(position: number) {
nextTick(() => {
asideContainerRef.value?.scrollTo({ top: position, behavior: 'smooth' })
})
}
provide('scroll-aside', scrollAside)
</script> </script>
<template> <template>
@ -25,7 +33,7 @@ const pageName = computed(() =>
<div class="container"> <div class="container">
<div v-if="hasAside" class="aside" :class="{'left-aside': leftAside}"> <div v-if="hasAside" class="aside" :class="{'left-aside': leftAside}">
<div class="aside-curtain" /> <div class="aside-curtain" />
<div class="aside-container"> <div ref="asideContainerRef" class="aside-container">
<div class="aside-content"> <div class="aside-content">
<VPDocAside> <VPDocAside>
<template #aside-top><slot name="aside-top" /></template> <template #aside-top><slot name="aside-top" /></template>

@ -1,6 +1,6 @@
import { getScrollOffset } from 'vitepress' import { getScrollOffset } from 'vitepress'
import type { DefaultTheme } from 'vitepress/theme' import type { DefaultTheme } from 'vitepress/theme'
import { onMounted, onUnmounted, onUpdated, type Ref } from 'vue' import { inject, onMounted, onUnmounted, onUpdated, type Ref } from 'vue'
import type { Header } from '../../shared' import type { Header } from '../../shared'
import { throttleAndDebounce } from '../support/utils' import { throttleAndDebounce } from '../support/utils'
import { useAside } from './aside' import { useAside } from './aside'
@ -84,6 +84,7 @@ export function useActiveAnchor(
marker: Ref<HTMLElement> marker: Ref<HTMLElement>
): void { ): void {
const { isAsideEnabled } = useAside() const { isAsideEnabled } = useAside()
const scrollAside = inject<(position: number) => void>('scroll-aside')
const onScroll = throttleAndDebounce(setActiveLink, 100) const onScroll = throttleAndDebounce(setActiveLink, 100)
@ -170,9 +171,11 @@ export function useActiveAnchor(
activeLink.classList.add('active') activeLink.classList.add('active')
marker.value.style.top = activeLink.offsetTop + 39 + 'px' marker.value.style.top = activeLink.offsetTop + 39 + 'px'
marker.value.style.opacity = '1' marker.value.style.opacity = '1'
scrollAside?.(activeLink.offsetTop + 39)
} else { } else {
marker.value.style.top = '33px' marker.value.style.top = '33px'
marker.value.style.opacity = '0' marker.value.style.opacity = '0'
scrollAside?.(33)
} }
} }
} }

Loading…
Cancel
Save