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(Layout): enhance layout styles #4679

Merged
merged 65 commits into from
Nov 16, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Nov 16, 2024

enhance layout styles

Summary of the changes (Less than 80 chars)

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

Description

fixes #4678

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

Enhance layout styles by refactoring CSS for better visual consistency and responsiveness. Update layout components to remove deprecated properties and improve configuration. Adjust documentation and tests to align with the new layout behavior.

Enhancements:

  • Refactor layout styles to improve the visual consistency and responsiveness of the layout components.

Documentation:

  • Update documentation to reflect changes in layout configuration and usage.

Tests:

  • Remove outdated test for 'IsPage' property and update tests to align with new layout behavior.

Copy link

sourcery-ai bot commented Nov 16, 2024

Reviewer's Guide by Sourcery

This PR refactors the Layout component's styles and structure to improve maintainability and mobile responsiveness. The changes include reorganizing SCSS code, removing deprecated features, and enhancing the responsive behavior of the layout components.

Class diagram for Layout component refactor

classDiagram
    class Layout {
        +bool IsPage
        +bool IsFullSide
        +bool IsFixedHeader
        +bool IsFixedFooter
        +bool ShowFooter
        +bool UseTabSet
        +void Update()
        +void ToggleSidebar()
        +void ClickMenu(MenuItem item)
        +void TriggerCollapseChanged()
    }
    note for Layout "IsPage is deprecated and should be removed."
    class PageLayout {
        +bool IsFixedTab
        +bool IsFixedHeader
        +bool IsFixedFooter
        +bool IsFullSide
        +bool ShowFooter
        +bool UseTabSet
        +void Update()
    }
    Layout <|-- PageLayout : inherits
    class LayoutPages {
        +List<SelectedItem> SideBarItems
        +SelectedItem ActiveItem
        +void OnInitialized()
        +Task OnFooterChanged(bool val)
        +Task OnTabStateChanged(CheckboxState state, bool val)
        +Task OnHeaderStateChanged(CheckboxState state, bool val)
        +Task OnSideChanged(IEnumerable<SelectedItem> values, SelectedItem item)
        +Task OnUseTabSetChanged(bool val)
        +void Update()
    }
Loading

File-Level Changes

Change Details Files
Refactored layout styles to improve mobile responsiveness and maintainability
  • Reorganized SCSS code structure for better readability
  • Simplified media queries for responsive behavior
  • Improved sidebar collapse/expand transitions
  • Enhanced z-index handling for overlays
  • Updated flexbox layout implementation
src/BootstrapBlazor/Components/Layout/Layout.razor.scss
Removed deprecated features and simplified component implementation
  • Removed IsPage parameter and related functionality
  • Simplified layout state management
  • Removed redundant CSS classes
  • Updated component initialization logic
src/BootstrapBlazor/Components/Layout/Layout.razor.cs
src/BootstrapBlazor/Components/Layout/Layout.razor
Enhanced layout component UI and user experience
  • Updated header and footer styling
  • Improved sidebar menu interactions
  • Enhanced layout banner component
  • Updated widget styling and structure
src/BootstrapBlazor.Server/Components/Layout/PageLayout.razor
src/BootstrapBlazor.Server/Components/Components/Widget.razor
Improved documentation and localization
  • Updated documentation links
  • Removed references to specific Visual Studio versions
  • Enhanced localization strings
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#4678 Enhance layout styles to improve code organization and maintainability

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 the enhancement New feature or request label Nov 16, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 16, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Nov 16, 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:

  • Consider documenting the new layout.css file and its purpose in the PR description, as this is a significant architectural change that other developers need to be aware of.
  • The removal of the IsPage parameter is a breaking change - please add a migration note to help users update their code.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟡 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.

# Conflicts:
#	src/BootstrapBlazor.Server/Locales/en-US.json
#	src/BootstrapBlazor.Server/Locales/zh-CN.json
Copy link

codecov bot commented Nov 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f24b4f4) to head (c89b9ed).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4679   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27427     27384   -43     
  Branches      3928      3929    +1     
=========================================
- Hits         27427     27384   -43     

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

@ArgoZhang ArgoZhang merged commit 1aacef5 into main Nov 16, 2024
4 checks passed
@ArgoZhang ArgoZhang deleted the refactory-layout-style branch November 16, 2024 15:35
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(Layout): enhance layout styles
1 participant