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

feat(GotoTop): support IsFixedTabHeader layout component #4883

Merged
merged 4 commits into from
Dec 18, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 18, 2024

support IsFixedTabHeader layout component

Summary of the changes (Less than 80 chars)

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

Description

fixes #4882

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 support for the IsFixedTabHeader layout component in the GoTop feature and refactor the GoTop component to use a data-bb-target attribute for specifying the scroll target.

New Features:

  • Add support for IsFixedTabHeader layout component in the GoTop feature.

Enhancements:

  • Refactor GoTop component to use a data-bb-target attribute for specifying scroll target.

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

sourcery-ai bot commented Dec 18, 2024

Reviewer's Guide by Sourcery

This PR implements support for IsFixedTabHeader layout component by modifying the GoTop component to work with fixed tab headers. The implementation moves the target element logic to the Layout component and passes it to GoTop through a data attribute, removing the need for JavaScript initialization.

Class diagram for Layout and GoTop components

classDiagram
    class Layout {
        - bool _init
        + string? GetTargetString()
    }
    class GoTop {
        - Task InvokeInitAsync()
    }
    Layout --> GoTop : uses
    note for Layout "GetTargetString method added to determine target element based on IsFixedTabHeader"
    note for GoTop "InvokeInitAsync method removed, target logic moved to Layout"
Loading

File-Level Changes

Change Details Files
Refactored GoTop component to use data attributes for target specification
  • Removed JavaScript initialization method
  • Added data-bb-target attribute to the anchor element
  • Updated JavaScript to read target from data-bb-target attribute
src/BootstrapBlazor/Components/GoTop/GoTop.razor
src/BootstrapBlazor/Components/GoTop/GoTop.razor.cs
src/BootstrapBlazor/Components/GoTop/GoTop.razor.js
Added support for fixed tab header in Layout component
  • Added GetTargetString method to determine scroll target based on IsFixedTabHeader property
  • Connected Layout's GoTop component with target string
  • Removed unused commented code and NET9_0_OR_GREATER conditional block
src/BootstrapBlazor/Components/Layout/Layout.razor
src/BootstrapBlazor/Components/Layout/Layout.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4882 Add support for IsFixedTabHeader layout component in GoTop functionality

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
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 18, 2024
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 complete the PR template with details about risk assessment and verification steps. This helps reviewers understand the impact and testing done.
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.

# Conflicts:
#	src/BootstrapBlazor/BootstrapBlazor.csproj

Co-authored-by: yuchen7701 <844356115@qq.com>
Co-authored-by: 卢骥 <1429614920@qq.com>
Co-authored-by: Argo Zhang <argo@live.ca>
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.99%. Comparing base (e332b14) to head (77c0954).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
.../BootstrapBlazor/Components/Layout/Layout.razor.cs 0.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              main    #4883      +/-   ##
===========================================
- Coverage   100.00%   99.99%   -0.01%     
===========================================
  Files          623      623              
  Lines        27832    27832              
  Branches      3982     3983       +1     
===========================================
- Hits         27832    27831       -1     
- Partials         0        1       +1     

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

@ArgoZhang ArgoZhang merged commit 36aa43d into main Dec 18, 2024
4 of 5 checks passed
@ArgoZhang ArgoZhang deleted the feat-footer branch December 18, 2024 07:30
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): support IsFixedTabHeader layout component
1 participant