Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 22, 2025

Link issues

fixes #6067

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Enable optional automatic scrolling to the top of a table upon page navigation by adding the IsAutoScrollTopWhenClickPage parameter, managing the scroll timing post-render, and enhancing the JS scrollTo helper for smooth scrolling.

New Features:

  • Introduce IsAutoScrollTopWhenClickPage parameter to automatically scroll table to the top on pagination

Enhancements:

  • Revise JavaScript scrollTo function to perform smooth top-left scrolling by default
  • Implement an internal flag to defer and trigger scrolling after render when pagination occurs

Documentation:

  • Modify sample page to demonstrate the new auto-scroll parameter with a fixed header setup

Tests:

  • Update table unit tests to include the IsAutoScrollTopWhenClickPage flag and adjust mock total count in query

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 22, 2025

Reviewer's Guide

Introduces the IsAutoScrollTopWhenClickPage flag to the Table component for optional smooth top-scrolling on pagination clicks via JS interop, fixes a cell alignment key, and updates samples and tests accordingly.

Sequence diagram for auto-scrolling on pagination click

sequenceDiagram
    actor User
    participant TableComponent as "Table Component (C#)"
    participant TableJs as "Table.razor.js"

    User->>TableComponent: Clicks pagination link
    TableComponent->>TableComponent: OnPageLinkClick(pageIndex)
    alt IsAutoScrollTopWhenClickPage is true
        TableComponent->>TableComponent: _shouldScrollTop = true
    end
    TableComponent->>TableComponent: OnAfterRenderAsync()
    alt _shouldScrollTop is true
      TableComponent->>TableComponent: _shouldScrollTop = false
      TableComponent->>TableJs: InvokeVoidAsync("scrollTo", Id)
      TableJs->>TableJs: scroll.scrollTo({ top: 0, left: 0, behavior: "smooth" })
    end
Loading

Updated class diagram for Table component and JavaScript interop

classDiagram
    class Table~TItem~ {
        +IsAutoScrollTopWhenClickPage: bool
        -_shouldScrollTop: bool
        #OnPageLinkClick(pageIndex: int): Task
        #OnAfterRenderAsync(firstRender: bool): Task
    }
    class TableJsInterop {
        <<JavaScript Module: Table.razor.js>>
        +scrollTo(id: string): void
    }
    Table~TItem~ ..> TableJsInterop : invokes
Loading

File-Level Changes

Change Details Files
Support auto-scroll-to-top on page navigation
  • Add IsAutoScrollTopWhenClickPage parameter
  • Track scroll request via _shouldScrollTop flag
  • Set _shouldScrollTop in OnPageLinkClick when flag is true
  • Invoke scrollTo in OnAfterRenderAsync based on _shouldScrollTop
Table.razor.cs
Table.razor.Pagination.cs
Refactor scrollTo JS function for smooth top scrolling
  • Remove x/y/options parameters from signature
  • Always scroll element to {top:0,left:0,behavior:'smooth'}
  • Target the .scroll container inside the table
Table.razor.js
Fix default cell alignment key
  • Change default Key from "align-left" to "align-right" for right alignment
Table.razor.cs
Update sample page to demonstrate auto-scroll
  • Enable IsAutoScrollTopWhenClickPage and IsFixedHeader
  • Set Height for scrollable area
TablesPages.razor
Extend pagination unit test for new flag
  • Add IsAutoScrollTopWhenClickPage parameter to test builder
  • Adjust TotalCount from items.Count() to fixed value
TableTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6067 When the Table component content has a scrollbar and the content is scrolled to the bottom, clicking the next page should automatically scroll back to the top.

Possibly linked issues


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

@bb-auto bb-auto bot added the enhancement New feature or request label May 22, 2025
@bb-auto bb-auto bot added this to the v9.6.0 milestone May 22, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) May 22, 2025 04:38
@codecov
Copy link

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (10a6739) to head (e76b913).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6077   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          701       701           
  Lines        30944     30956   +12     
  Branches      4376      4378    +2     
=========================================
+ Hits         30944     30956   +12     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 22, 2025
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 - here's some feedback:

  • The alignment icon key change from "align-left" to "align-right" in Table.razor.cs seems unrelated to the scroll feature—consider splitting it into its own PR for clarity.
  • In scrollTop, add a guard for when table.tables is empty or undefined to avoid potential runtime errors before accessing tables[0] or tables[1].
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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.

@ArgoZhang
Copy link
Member Author

@sourcery-ai review

sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 22, 2025
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.

@ArgoZhang ArgoZhang merged commit 36a0211 into main May 22, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-table branch May 22, 2025 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Table): 组件内容翻页后能否自动滚到顶部

2 participants