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(LayoutSplitebar): Enhanced javascript handle sidebar width is not set #5512

Merged
merged 5 commits into from
Mar 4, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 4, 2025

Link issues

fixes #5511

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor project, focusing on the removal of unused components and improvements to the layout split bar functionality. The most important changes include the removal of the OnlineSheet component and the enhancement of the init function in LayoutSplitebar.razor.js.

Removal of OnlineSheet component:

Improvements to layout split bar functionality:

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

Refactors the LayoutSplitebar component to handle cases where the sidebar width is not explicitly set, providing a default value. Removes the OnlineSheet component.

Enhancements:

  • Enhances the init function in LayoutSplitebar.razor.js to handle cases where the sidebar width is not set, ensuring a default value is applied.
  • Updates the OnlineSheet class to remove the ComponentBase inheritance, and removes the OnlineSheet component.

Copy link

sourcery-ai bot commented Mar 4, 2025

Reviewer's Guide by Sourcery

This pull request removes the unused OnlineSheet component and improves the LayoutSplitebar component by ensuring a default sidebar width is applied when it is not explicitly set. The init function in LayoutSplitebar.razor.js was updated to handle cases where the sidebar width is not set, providing a default value.

Sequence diagram for LayoutSplitebar init function

sequenceDiagram
  participant JSInterop as JS
  participant section
  participant bar

  JS->>JS: init(id)
  JS->>section: getComputedStyle(section).getPropertyValue('--bb-layout-sidebar-width')
  alt widthString is empty
    JS->>section: section.style.setProperty('--bb-layout-sidebar-width', '0')
  end
  JS->>section: parseInt(widthString)
  JS->>bar: Drag.drag(bar, drag, move)

  loop Dragging
    bar->>section: section.classList.add('drag')
    bar->>section: getComputedStyle(section).getPropertyValue('--bb-layout-sidebar-width')
    bar->>JS: eventX - originX
    JS->>JS: newWidth = width + moveX
    alt newWidth < min
      JS->>JS: newWidth = min
    end
    JS->>section: section.style.setProperty('--bb-layout-sidebar-width', newWidth)
  end
Loading

File-Level Changes

Change Details Files
Removed the OnlineSheet component and related files.
  • Removed the OnlineSheet.razor file.
  • Removed the OnlineSheet.razor.cs file.
  • Removed the OnlineSheet.razor.css file.
  • Updated the OnlineSheet class to remove the ComponentBase inheritance.
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet.razor.css
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor.cs
Enhanced the init function in LayoutSplitebar.razor.js to handle cases where the sidebar width is not explicitly set.
  • Added a check for an empty width string.
  • Set the sidebar width to '0' if it is not already set.
  • Ensured that widthString is assigned '0' when the width is not set.
src/BootstrapBlazor/Components/Layout/LayoutSplitebar.razor.js

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 Mar 4, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 4, 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:

  • Consider adding a try-catch block around the parseInt call in LayoutSplitebar.razor.js to handle potential parsing errors.
  • The code in LayoutSplitebar.razor.js modifies the style directly; consider if this could be done with CSS classes instead.
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.

@ArgoZhang ArgoZhang enabled auto-merge (squash) March 4, 2025 07:11
Copy link

codecov bot commented Mar 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (27f8299) to head (4d04f95).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5512   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29563     29563           
  Branches      4165      4165           
=========================================
  Hits         29563     29563           

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

@ArgoZhang ArgoZhang merged commit 91eebc2 into main Mar 4, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-layout branch March 4, 2025 07:12
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(LayoutSplitebar): Enhanced javascript handle sidebar width is not set
1 participant