Skip to content

🐛 fix: Sync Table of Contents (TOC) with scroll position#71

Open
Darkingtail wants to merge 2 commits intolobehub:mainfrom
Darkingtail:fix/sync_TOC_scroll
Open

🐛 fix: Sync Table of Contents (TOC) with scroll position#71
Darkingtail wants to merge 2 commits intolobehub:mainfrom
Darkingtail:fix/sync_TOC_scroll

Conversation

@Darkingtail
Copy link

@Darkingtail Darkingtail commented Dec 3, 2025

💻 变更类型 | Change Type

  • ✨ feat
  • 🐛 fix
  • 💄 style
  • 🔨 chore
  • 📝 docs

🔀 变更说明 | Description of Change

📝 补充信息 | Additional Information

Summary by Sourcery

Bug Fixes:

  • Fix Table of Contents scroll syncing by targeting the window as the container instead of the document body.

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 3, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adjusts the Table of Contents (TOC) component so its scroll tracking uses the window as the scroll container instead of the document body, fixing TOC sync with page scroll position.

Sequence diagram for TOC scroll sync using window as container

sequenceDiagram
  actor User
  participant BrowserWindow
  participant TocComponent
  participant TocScrollTracker

  User->>BrowserWindow: Scroll page
  BrowserWindow->>TocComponent: scroll event
  TocComponent->>TocScrollTracker: getContainer returns window
  TocScrollTracker->>BrowserWindow: Read scroll position (scrollY)
  TocScrollTracker->>TocComponent: Compute active heading index
  TocComponent->>TocComponent: Update active TOC item
  TocComponent-->>User: TOC highlight matches scroll position
Loading

File-Level Changes

Change Details Files
Update TOC scroll container source to use the window object.
  • Change the getContainer callback to return window instead of document.body so TOC scroll behavior aligns with the actual scrollable viewport.
src/slots/Toc/index.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • Switching getContainer from document?.body to window may break in SSR or non-browser environments where window is undefined; consider guarding this or preserving the optional chaining pattern.
  • Verify that the T component’s getContainer type expects a Window object and not an HTMLElement, as changing from document.body to window could introduce subtle runtime issues if the type or underlying implementation assumes a DOM element.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Switching `getContainer` from `document?.body` to `window` may break in SSR or non-browser environments where `window` is undefined; consider guarding this or preserving the optional chaining pattern.
- Verify that the `T` component’s `getContainer` type expects a `Window` object and not an `HTMLElement`, as changing from `document.body` to `window` could introduce subtle runtime issues if the type or underlying implementation assumes a DOM element.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant