Skip to content

docs: fix back to top does not work and the document tab title does n… #2712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 30, 2024
Merged

docs: fix back to top does not work and the document tab title does n… #2712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions examples/sites/src/views/components/components.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</div>
<span class="docs-header-spacer"></span>
</header>
<div class="docs-content" id="doc-layout-scoller">
<div class="docs-content" id="doc-layout-scroller">
<div class="ti-rel cmp-container">
<div class="flex-horizontal docs-content-main">
<div class="docs-tabs-wrap">
Expand Down Expand Up @@ -233,11 +233,12 @@
<div class="cmp-page-anchor catalog" v-if="currAnchorLinks.length">
<tiny-anchor
id="anchor"
:offset-top="56"
:links="currAnchorLinks"
:key="anchorRefreshKey"
:is-affix="anchorAffix"
type="dot"
container-id="#doc-layout-scoller"
container-id="#doc-layout-scroller"
@link-click="handleAnchorClick"
>
</tiny-anchor>
Expand Down Expand Up @@ -469,7 +470,7 @@ export default defineComponent({
const scrollByHash = (hash) => {
setTimeout(() => {
if (!hash) {
document.getElementById('doc-layout-scoller').scrollTo({
document.getElementById('doc-layout-scroller').scrollTo({
top: 0,
left: 0
})
Expand All @@ -482,10 +483,10 @@ export default defineComponent({
scrollTarget = document.querySelector(`#${hash}`)
} catch (err) {}
if (scrollTarget && !isRunningTest) {
// doc-layout-scoller(滚动) > tabs > tab-content(relative)， 造成 scrollTarget.offsetTop 是相对于 tab-content的距离
// doc-layout-scroller(滚动) > tabs > tab-content(relative)， 造成 scrollTarget.offsetTop 是相对于 tab-content的距离
// 所以滚动需要修正 tab-title的占位高度才行
document.getElementById('doc-layout-scoller').scrollTo({
top: scrollTarget.offsetTop + 52,
document.getElementById('doc-layout-scroller').scrollTo({
top: scrollTarget.offsetTop,
Copy link

@petercat-assistant petercat-assistant bot Dec 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The removal of + 52 from scrollTarget.offsetTop may affect the scroll position. Ensure that this change does not negatively impact the intended scroll behavior.

left: 0,
behavior: 'smooth'
})
Expand All @@ -499,7 +500,7 @@ export default defineComponent({
let hash = router.currentRoute.value.hash?.slice(1)
if (hash !== 'API') {
setTimeout(() => {
document.getElementById('doc-layout-scoller').scrollTo({
document.getElementById('doc-layout-scroller').scrollTo({
top: 0,
left: 0,
behavior: 'smooth'
Expand Down Expand Up @@ -620,26 +621,26 @@ export default defineComponent({
}

const onDocLayoutScroll = debounce(100, false, () => {
const docLayout = document.getElementById('doc-layout-scoller')
const docLayout = document.getElementById('doc-layout-scroller')
const { scrollTop, scrollHeight, clientHeight: layoutHeight } = docLayout
const headerHeight = document.querySelector('.docs-header')?.clientHeight || 0
const footerHeight = document.getElementById('footer')?.clientHeight || 0
const anchorHeight = document.querySelector('#anchor')?.clientHeight || 0
const remainHeight = scrollHeight - scrollTop - layoutHeight // doc-layout-scoller视口下隐藏的部分高度
const remainHeight = scrollHeight - scrollTop - layoutHeight // doc-layout-scroller视口下隐藏的部分高度
state.anchorAffix = layoutHeight - headerHeight - (footerHeight - remainHeight) > anchorHeight
})

const setScrollListener = () => {
nextTick(() => {
const docLayout = document.getElementById('doc-layout-scoller')
const docLayout = document.getElementById('doc-layout-scroller')
if (docLayout) {
docLayout.addEventListener('scroll', onDocLayoutScroll)
}
})
}

const removeScrollListener = () => {
const docLayout = document.getElementById('doc-layout-scoller')
const docLayout = document.getElementById('doc-layout-scroller')
if (docLayout) {
docLayout.removeEventListener('scroll', onDocLayoutScroll)
}
Expand Down Expand Up @@ -802,7 +803,7 @@ export default defineComponent({
.docs-content {
flex: 1;
overflow: hidden auto;
padding: 16px 0 0;
margin-top: 16px;
transition: all ease-in-out 0.3s;

.docs-tabs-wrap {
Expand All @@ -826,6 +827,7 @@ export default defineComponent({

:deep(> .tiny-tabs__header) {
position: sticky;
top: 0;
z-index: var(--docs-tabs-header-zindex);
background-color: #fff;

Expand Down
6 changes: 3 additions & 3 deletions examples/sites/src/views/components/float-settings.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ export default defineComponent({

const funcs = {
onBackTop() {
document.getElementById('doc-layout').scrollTo({
document.getElementById('doc-layout-scroller').scrollTo({
top: 0,
left: 0,
behavior: 'smooth'
Expand Down Expand Up @@ -196,7 +196,7 @@ export default defineComponent({

const setScrollListener = () => {
nextTick(() => {
const docLayout = document.getElementById('doc-layout')
const docLayout = document.getElementById('doc-layout-scroller')
const nav = document.querySelector('.nav')
if (docLayout) {
docLayout.onscroll = debounce(100, false, () => {
Expand All @@ -218,7 +218,7 @@ export default defineComponent({
}

const removeScrollListener = () => {
const docLayout = document.getElementById('doc-layout') || {}
const docLayout = document.getElementById('doc-layout-scroller') || {}
docLayout.onscroll = null
}

Expand Down
Loading