chore: support outline anchor point

[qinluhe]

Description

---

Checklist

General

• I've included relevant documentation or comments for the changes introduced.
• I've tested the changes in multiple environments (e.g., different browsers, operating systems).

Testing

• I've added or updated tests to validate the changes introduced for AppFlowy Web.

Feature-Specific

• For feature additions, I've added a preview (video, screenshot, or demo) in the "Feature Preview" section.
• I've verified that this feature integrates seamlessly with existing functionality.

Summary by Sourcery

Modify scrolling behavior and anchor point support for document elements

Enhancements:

• Update scrolling mechanism to use native scrollIntoView instead of third-party smooth scroll library
• Add scroll margin top for better element positioning
• Simplify block jumping and URL state management

Chores:

• Remove dependency on smooth-scroll-into-view-if-needed library
• Refactor scrolling and highlighting logic in document components

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enhances the outline feature by adding support for anchor points. When a user clicks on an outline item, the corresponding block in the editor will be scrolled into view and highlighted. The implementation involves modifying the Element component to handle the scrolling and highlighting logic, and updating the Outline component to trigger the scroll when an item is clicked.

Sequence diagram for outline item click

sequenceDiagram
    participant User
    participant Outline
    participant Element

    User->>Outline: Clicks on outline item
    Outline->>Element: Calls scrollIntoView()
    Element->>Element: Adds highlight class
    Element->>User: Scrolls block into view and highlights it

Loading

Updated class diagram for Element component

classDiagram
    class Element {
        +blockId: string
        +type: BlockType
        +isSelected: boolean
        +selected: boolean
        +highlightTimeoutRef: useRef
        +useEffect()
        +Component: React.FC
        +blockStyle: CSSProperties
        +properties: object
    }

    note for Element "Modified to handle scrolling and highlighting on jumpBlockId change"

Loading

File-Level Changes

Change	Details	Files
Implemented smooth scrolling and highlighting of blocks when navigating via outline anchor points.	Added logic to scroll the target element into view. Added logic to highlight the target element. Added logic to remove the highlight after a delay.	src/components/editor/components/element/Element.tsx
Modified the Outline component to trigger scrolling when an outline item is clicked.	Removed smoothScrollIntoViewIfNeeded. Used element.scrollIntoView instead.	src/components/editor/components/blocks/outline/Outline.tsx
Removed unnecessary code in Document.tsx.	Removed setSearch function in onJumpedBlockId callback.	src/components/document/Document.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!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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

Overall Comments:

• The removal of smooth-scroll-into-view-if-needed and usage of element.scrollIntoView is good, but consider adding behavior: 'smooth' for a smoother transition.
• The setTimeout in Element.tsx might be better handled with useLayoutEffect to avoid potential visual glitches before the scroll happens.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}