Skip to content

feat(LayoutSidebar): add LayoutSplitebar component #5438

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

Merged
merged 7 commits into from
Feb 24, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 24, 2025

add LayoutSidebar component

Summary of the changes (Less than 80 chars)

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

Description

fixes #5437

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

This pull request introduces a new LayoutSidebar component that allows users to resize the sidebar. The Layout component was refactored to use a RenderSide fragment, improving code organization and reusability. A ShowSplitBar parameter was added to the Layout component to control the visibility of the LayoutSidebar component.

New Features:

  • Introduces a new LayoutSidebar component that allows users to resize the sidebar.

Enhancements:

  • Refactors the Layout component to use a RenderSide fragment, improving code organization and reusability.
  • Adds a ShowSplitBar parameter to the Layout component to control the visibility of the LayoutSidebar component.

Build:

  • Adds a new scss file for the LayoutSidebar component.

Tests:

  • No tests were added as part of this change.

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 24, 2025
Copy link
Contributor

sourcery-ai bot commented Feb 24, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new LayoutSidebar component that allows users to resize the sidebar. The LayoutSidebar component is integrated into the Layout and MainLayout components, replacing the old sidebar resizer implementation. A new scss file was added for styling the component, and the components.scss file was updated to import the new scss file.

Class diagram for LayoutSidebar component

classDiagram
  class LayoutSidebar {
    +string? ContainerSelector
    +int? Min
    +int? Max
  }
  LayoutSidebar : BootstrapModuleComponentBase
  note for LayoutSidebar "Component to allow resizing of the sidebar"
Loading

File-Level Changes

Change Details Files
Introduced a new LayoutSidebar component for adjusting the sidebar width.
  • Created LayoutSidebar component with drag functionality.
  • Added JavaScript module LayoutSidebar.razor.js to handle drag events and update sidebar width.
  • Added scss file LayoutSidebar.razor.scss for styling the component.
  • Added properties ContainerSelector, Min, and Max to the LayoutSidebar component to allow customization of the drag area and width limits.
src/BootstrapBlazor/Components/Layout/LayoutSidebar.razor.js
src/BootstrapBlazor/Components/Layout/LayoutSidebar.razor.scss
src/BootstrapBlazor/Components/Layout/LayoutSidebar.razor.cs
src/BootstrapBlazor/Components/Layout/LayoutSidebar.razor
Integrated the LayoutSidebar component into the Layout component and MainLayout component.
  • Added ShowSplitBar parameter to the Layout component to control the visibility of the LayoutSidebar.
  • Modified RenderSide render fragment in Layout component to include the LayoutSidebar component when ShowSplitBar is enabled.
  • Removed the old sidebar resizer implementation from NavMenu.razor.js.
  • Added LayoutSidebar to MainLayout.razor to replace the old sidebar resizer implementation.
  • Updated MainLayout.razor.css to use --bb-layout-sidebar-width instead of --bb-sidebar-width.
src/BootstrapBlazor/Components/Layout/Layout.razor
src/BootstrapBlazor.Server/Components/Layout/NavMenu.razor.js
src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor.css
src/BootstrapBlazor/Components/Layout/Layout.razor.cs
src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor
Imported the new LayoutSidebar.razor.scss file in components.scss.
  • Added @import "../../Components/Layout/LayoutSidebar.razor.scss"; to the components.scss file.
src/BootstrapBlazor/wwwroot/scss/components.scss

Assessment against linked issues

Issue Objective Addressed Explanation
#5437 Add a LayoutSidebar component to the BootstrapBlazor library.

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. 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 this to the v9.3.0 milestone Feb 24, 2025
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:

  • Consider using a consistent naming scheme, such as LayoutSplitter, to better reflect the component's purpose.
  • The javascript interop could be moved into the component to make it more self-contained.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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 Feb 24, 2025

Codecov Report

Attention: Patch coverage is 68.18182% with 7 lines in your changes missing coverage. Please review.

Project coverage is 99.97%. Comparing base (4759e19) to head (d54d0b4).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...rapBlazor/Components/Layout/LayoutSidebar.razor.cs 0.00% 5 Missing ⚠️
src/BootstrapBlazor/Components/Layout/Layout.razor 87.50% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              main    #5438      +/-   ##
===========================================
- Coverage   100.00%   99.97%   -0.03%     
===========================================
  Files          645      646       +1     
  Lines        29355    29349       -6     
  Branches      4131     4129       -2     
===========================================
- Hits         29355    29342      -13     
- Misses           0        7       +7     

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

@ArgoZhang ArgoZhang merged commit 69179e7 into main Feb 24, 2025
4 of 6 checks passed
@ArgoZhang ArgoZhang deleted the feat-layout branch February 24, 2025 12:58
@ArgoZhang ArgoZhang changed the title feat(LayoutSidebar): add LayoutSidebar component feat(LayoutSidebar): add LayoutSplitebar component Feb 25, 2025
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(LayoutSidebar): add LayoutSplitebar component
1 participant