Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 18, 2024

add ScrollBehavior parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #4884

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

Add a ScrollBehavior parameter to the GoTop component to allow customization of scroll behavior, and update the component to handle this new parameter. Enhance the component's functionality by supporting different scroll behaviors and add corresponding unit tests to verify the implementation.

New Features:

  • Introduce a ScrollBehavior parameter to the GoTop component, allowing customization of scroll behavior.

Enhancements:

  • Enhance the GoTop component to support different scroll behaviors by adding a data-bb-behavior attribute.

Tests:

  • Add unit tests for the new ScrollBehavior parameter in the GoTop component to ensure correct behavior.

@bb-auto bb-auto bot added the enhancement New feature or request label Dec 18, 2024
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 18, 2024

Reviewer's Guide by Sourcery

This PR adds a ScrollBehavior parameter to the GoTop component, allowing customization of the scroll animation behavior. The implementation includes updates to the component's parameters, markup, and JavaScript code to support both smooth and auto scroll behaviors.

Sequence diagram for GoTop component scroll behavior

sequenceDiagram
    actor User
    participant GoTopComponent as GoTop Component
    participant JSFunction as JavaScript Function

    User->>GoTopComponent: Click GoTop button
    GoTopComponent->>JSFunction: init(id, target)
    JSFunction->>JSFunction: Get data-bb-target and data-bb-behavior
    JSFunction->>JSFunction: element.scrollTo({ top: 0, left: 0, behavior: behavior })
    JSFunction-->>User: Scroll to top with specified behavior
Loading

Class diagram for GoTop component with ScrollBehavior

classDiagram
    class GoTop {
        +string? Target
        +ScrollIntoViewBehavior ScrollBehavior
        +string? TooltipText
        -IIconTheme? IconTheme
        -string? ScrollBehaviorString
    }
    note for GoTop "Added ScrollBehavior parameter and ScrollBehaviorString property"
Loading

File-Level Changes

Change Details Files
Added ScrollBehavior parameter to control scroll animation
  • Added ScrollBehavior parameter with default value of Smooth
  • Created helper property ScrollBehaviorString to convert behavior to lowercase string
  • Added data-bb-behavior attribute to component markup
  • Updated JavaScript to use scrollTo with configurable behavior
src/BootstrapBlazor/Components/GoTop/GoTop.razor.cs
src/BootstrapBlazor/Components/GoTop/GoTop.razor
src/BootstrapBlazor/Components/GoTop/GoTop.razor.js
Added unit tests for new ScrollBehavior functionality
  • Added test case for default smooth behavior
  • Added test case for auto scroll behavior
  • Added test for data-bb-behavior attribute presence
  • Added test for target attribute presence
test/UnitTest/Components/GoTopTest.cs
test/UnitTest/Components/LayoutTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4884 Add ScrollBehavior parameter to GoTop component

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

@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 18, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 18, 2024 11:17
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:

Overall Comments:

  • Please provide a more detailed English description of the changes and complete the PR template sections (particularly risk assessment and verification details).
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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 ArgoZhang merged commit 578c404 into main Dec 18, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-gotop branch December 18, 2024 11:25
@codecov
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (36aa43d) to head (54cbafc).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #4885   +/-   ##
========================================
  Coverage   99.99%   100.00%           
========================================
  Files         623       623           
  Lines       27832     27834    +2     
  Branches     3983      3984    +1     
========================================
+ Hits        27831     27834    +3     
+ Partials        1         0    -1     

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

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(GotoTop): add ScrollBehavior parameter

2 participants