feat(Affix): add Affix component #5093

ArgoZhang · 2025-01-11T05:10:24Z

add Affix component

Summary of the changes (Less than 80 chars)

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

Description

fixes #5092

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

New Features:

Added an Affix component to allow elements to stick to a fixed position on the page.

Co-Authored-By: Zeus <[email protected]> Co-Authored-By: Alex chow <[email protected]>

sourcery-ai · 2025-01-11T05:10:28Z

Reviewer's Guide by Sourcery

This pull request introduces the new Affix component, which allows elements to become sticky during scrolling. It includes the component implementation, demo, and tests.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added the Affix component.	Created the Affix component to enable sticky positioning of elements. Added AffixPosition enum to define the position of the sticky element. Implemented the logic for sticky positioning based on scroll offset and position. Added unit tests to verify the functionality of the component Added SCSS file to style the component Added component to project	`src/BootstrapBlazor/Components/Affix/Affix.razor` `src/BootstrapBlazor/Components/Affix/Affix.razor.cs` `src/BootstrapBlazor/Components/Affix/Affix.razor.scss` `src/BootstrapBlazor/BootstrapBlazor.csproj` `src/BootstrapBlazor/Enums/AffixPosition.cs` `test/UnitTest/Components/AffixTest.cs`
Added the Affix demo page.	Created a demo page to showcase the usage of the Affix component. Added examples for different positioning options and offset configurations. Added localizer for the demo page	`src/BootstrapBlazor.Server/Components/Samples/Affixs.razor` `src/BootstrapBlazor.Server/Components/Samples/Affixs.razor.cs`
Updated the menu and localization files.	Added the Affix component to the menu. Updated localization files with new entries for the Affix component. Updated documentation for the Affix component Included the Affix component's SCSS file in the main SCSS file	`src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs` `src/BootstrapBlazor.Server/Locales/en-US.json` `src/BootstrapBlazor.Server/Locales/zh-CN.json` `src/BootstrapBlazor.Server/docs.json` `src/BootstrapBlazor/wwwroot/scss/components.scss`

Assessment against linked issues

Issue	Objective	Addressed
#5092	Add Affix component to the project	✅
#5092	Implement basic functionality for sticky positioning	✅
#5092	Provide configuration options for the Affix component	✅

Possibly linked issues

feat(Affix): add Affix component #5092: The PR implements the Affix component requested in the issue.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

Please fill out the PR template sections for Risk and Verification to help reviewers understand the testing performed and potential impact of these changes.

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

ArgoZhang · 2025-01-11T05:12:49Z

@sourcery-ai review

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

Please include the localization strings in the en-US.json and zh-CN.json files for the new Affix component

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 · 2025-01-11T05:14:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5093   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       632    +1     
  Lines        28084     28096   +12     
  Branches      4035      4035           
=========================================
+ Hits         28084     28096   +12

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

ArgoZhang · 2025-01-11T05:25:26Z

@sourcery-ai review

sourcery-ai

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: 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.}

test/UnitTest/Components/AffixTest.cs

ArgoZhang and others added 5 commits January 11, 2025 10:29

chore: bump version 9.2.7-beta05

4e7b60a

Co-Authored-By: Zeus <[email protected]> Co-Authored-By: Alex chow <[email protected]>

feat: 增加 Affix 组件

2461fe5

doc: 增加 Affix 文档

dc46216

doc: 更新标志

63d46a4

doc: 更新菜单本地化

644a2c0

bb-auto bot assigned ArgoZhang Jan 11, 2025

bb-auto bot added the enhancement New feature or request label Jan 11, 2025

bb-auto bot added this to the v9.2.0 milestone Jan 11, 2025

chore: bump version 9.2.7-beta06

cb84f77

sourcery-ai bot previously approved these changes Jan 11, 2025

View reviewed changes

ArgoZhang dismissed sourcery-ai[bot]’s stale review via cb84f77 January 11, 2025 05:11

Merge remote-tracking branch 'gitee.com/test-pr' into feat-affix

80e0d74

# Conflicts: # src/BootstrapBlazor/BootstrapBlazor.csproj

ArgoZhang enabled auto-merge (squash) January 11, 2025 05:12

sourcery-ai bot previously approved these changes Jan 11, 2025

View reviewed changes

test: 增加单元测试

a162771

ArgoZhang dismissed sourcery-ai[bot]’s stale review via a162771 January 11, 2025 05:24

sourcery-ai bot approved these changes Jan 11, 2025

View reviewed changes

test/UnitTest/Components/AffixTest.cs Show resolved Hide resolved

ArgoZhang disabled auto-merge January 11, 2025 05:27

ArgoZhang merged commit d533904 into main Jan 11, 2025
5 checks passed

ArgoZhang deleted the feat-affix branch January 11, 2025 05:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(Affix): add Affix component #5093

feat(Affix): add Affix component #5093

Uh oh!

ArgoZhang commented Jan 11, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jan 11, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

ArgoZhang commented Jan 11, 2025

Uh oh!

sourcery-ai bot left a comment

Uh oh!

codecov bot commented Jan 11, 2025 •

edited

Loading

Uh oh!

ArgoZhang commented Jan 11, 2025

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat(Affix): add Affix component #5093

feat(Affix): add Affix component #5093

Uh oh!

Conversation

ArgoZhang commented Jan 11, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

add Affix component

Description

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jan 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

ArgoZhang commented Jan 11, 2025

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ArgoZhang commented Jan 11, 2025

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ArgoZhang commented Jan 11, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jan 11, 2025 •

edited

Loading

codecov bot commented Jan 11, 2025 •

edited

Loading