Skip to content
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.

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

refactor(ScrollIntoView): use nearest value instead of center #5049

Merged
merged 6 commits into from
Jan 6, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 6, 2025

use nearest value instead of center

Summary of the changes (Less than 80 chars)

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

Description

fixes #5048

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

Enhancements:

  • Improve the scrolling behavior in several components, including AutoComplete, Table, Select, and TreeView, by using "nearest" instead of "center" for vertical alignment.

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 6, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 6, 2025
Copy link

sourcery-ai bot commented Jan 6, 2025

Reviewer's Guide by Sourcery

This PR refactors the scrollIntoView behavior to use "nearest" value instead of "center" for vertical alignment. This change improves scrolling behavior in several components, including AutoComplete, Select, Table, and TreeView, by ensuring the selected item is fully visible within the viewport.

Sequence diagram for updated scrolling behavior in components

sequenceDiagram
    participant User
    participant Component
    participant ScrollHandler

    User->>Component: Keyboard navigation (Up/Down)
    Component->>ScrollHandler: scrollIntoView()
    Note over ScrollHandler: Changed block: 'center' to 'nearest'
    ScrollHandler-->>Component: Scroll item into view
    Component-->>User: Show selected item in viewport
Loading

Class diagram showing ScrollIntoView configuration changes

classDiagram
    class AutoComplete {
        -scrollIntoView(el, item)
        +handleKeyUp()
    }
    class Select {
        -scrollIntoView(el, item)
    }
    class TreeView {
        +ScrollIntoViewOptions: ScrollIntoViewOptions?
        +scroll(id, options)
    }
    class ScrollIntoViewOptions {
        +behavior: string
        +block: string
        +inline: string
    }
    note for ScrollIntoViewOptions "block changed from 'center' to 'nearest'"
    TreeView --> ScrollIntoViewOptions
    AutoComplete --> ScrollIntoViewOptions
    Select --> ScrollIntoViewOptions
Loading

File-Level Changes

Change Details Files
Updated scrollIntoView behavior to use "nearest" vertical alignment
  • Changed the scrollIntoView block option from "center" to "nearest".
  • Removed unnecessary calculations for scrolling offsets.
  • Simplified the scrolling logic by directly using the scrollIntoView function with the "nearest" option.
  • Updated the documentation for the ScrollIntoViewOptions parameter to reflect the new default behavior.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js
src/BootstrapBlazor.Server/Components/Samples/Table/TablesSelection.razor.js
src/BootstrapBlazor/Components/Select/Select.razor.js
src/BootstrapBlazor/Components/TreeView/TreeView.razor.js
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5048 Use nearest value instead of center for scrolling behavior

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.
  • 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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 6, 2025
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 @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please document what manual testing was performed to verify the scrolling behavior changes across all affected components (AutoComplete, Table, Select, TreeView).
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f5f401d) to head (c9453fc).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5049   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27964     27964           
  Branches      4008      4008           
=========================================
  Hits         27964     27964           

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

@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

@ArgoZhang ArgoZhang merged commit 0ea46bb into main Jan 6, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-scroll branch January 6, 2025 09:57
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.

refactor(ScrollIntoView): use nearest value instead of center
1 participant