Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 11, 2025

refactor scroll behavior

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5090

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Update the scroll behavior of the layout component to scroll to the anchor.

New Features:

  • Implement scroll-to-anchor functionality in the layout component.

Enhancements:

  • Remove unnecessary height setting for the main layout element.

Tests:

  • Update tests to cover the new scroll behavior.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jan 11, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 11, 2025

Reviewer's Guide by Sourcery

This PR refactors the scroll behavior of the ComponentLayout component to fix a bug where the page would not scroll to the correct anchor when a hash is present in the URL. The init method in the ComponentLayout JavaScript file is renamed to scrollToAnchor, and now correctly handles anchor navigation. Additionally, the IdComponentBase now uses IComponentIdGenerator for ID generation, and unnecessary height styling is removed from the MainLayout CSS.

Sequence diagram for updated anchor scroll behavior

sequenceDiagram
    participant U as User
    participant CL as ComponentLayout
    participant JS as JavaScript
    participant DOM as Browser DOM

    U->>CL: Navigate to URL with hash
    activate CL
    Note over CL: OnAfterRenderAsync
    CL->>JS: InvokeVoidAsync('scrollToAnchor')
    activate JS
    JS->>JS: Get hash from location
    JS->>JS: Decode URI
    JS->>JS: Split hash to get anchor
    JS->>DOM: Scroll to anchor element
    deactivate JS
    deactivate CL
Loading

File-Level Changes

Change Details Files
Refactor ComponentLayout to scroll to anchor on page load
  • Renamed init function to scrollToAnchor in ComponentLayout.razor.js
  • Updated ComponentLayout.razor.cs to call scrollToAnchor after render
  • Corrected anchor scrolling logic to handle hash navigation
src/BootstrapBlazor.Server/Components/Layout/ComponentLayout.razor.js
src/BootstrapBlazor.Server/Components/Layout/ComponentLayout.razor.cs
Update IdComponentBase to use IComponentIdGenerator
  • Inject IComponentIdGenerator into IdComponentBase
  • Use IComponentIdGenerator to generate IDs
src/BootstrapBlazor/Components/BaseComponents/IdComponentBase.cs
Remove unnecessary height styling from MainLayout
  • Removed fixed height rule from .main class
src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor.css

Assessment against linked issues

Issue Objective Addressed Explanation
#5090 Add sample code for {Component} The PR does not include any sample code for a specific component as mentioned in the issue body.
#5090 Refactor scroll behavior documentation

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 11, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 11, 2025 02:32
Copy link
Contributor

@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 @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@codecov
Copy link

codecov bot commented Jan 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6f64911) to head (dd5a7ce).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5091   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        28084     28084           
  Branches      4035      4035           
=========================================
  Hits         28084     28084           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 6d10281 into main Jan 11, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-scroll branch January 11, 2025 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(ComponentLayout): refactor scroll behavior

2 participants