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

fix: mixed menu layout in full content mode #4990

Merged
merged 1 commit into from
Dec 1, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Nov 30, 2024

Description

修复混合菜单布局在内容区域最大化时侧边菜单的样式问题。fixed #4989

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Enhanced sidebar visibility logic, ensuring it only appears when not hidden.
    • Improved mobile layout behavior with refined mask visibility based on sidebar state.
  • Bug Fixes

    • Adjusted sidebar width calculation to ensure correct behavior when width is set to zero.

Copy link

changeset-bot bot commented Nov 30, 2024

⚠️ No Changeset found

Latest commit: 96b0c17

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Nov 30, 2024

Walkthrough

The changes in this pull request primarily focus on modifying the layout-sidebar.vue and vben-layout.vue components. In layout-sidebar.vue, the calcMenuWidthStyle function was updated to set widthValue to '0px' when the width prop is 0. In vben-layout.vue, the showSidebar and maskVisible computed properties were enhanced to refine the visibility logic of the sidebar and mask based on specific conditions. These updates aim to improve the layout behavior of the sidebar and its interaction with other UI elements.

Changes

File Path Change Summary
packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue Updated calcMenuWidthStyle to set widthValue to '0px' if width is 0.
packages/@core/ui-kit/layout-ui/src/vben-layout.vue Enhanced showSidebar and maskVisible computed properties for improved visibility logic.

Assessment against linked issues

Objective Addressed Explanation
Bug: 双列菜单布局情况下,全屏导致样式错乱 (#4989)

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

In the layout where sidebars play,
A tweak to width keeps chaos at bay.
With styles refined and logic anew,
The sidebar dances, a joyful view!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue

Oops! Something went wrong! :(

ESLint: 9.15.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue (1)

Line range hint 194-211: Consider improving width calculation maintainability.

The width calculation logic is spread across multiple places and handles various states. Consider these improvements:

  1. Extract width calculation into a separate composable for better reusability
  2. Add JSDoc comments documenting the different width states
  3. Consider using TypeScript const assertions for width values

Example refactor:

/**
 * Composable for sidebar width calculations
 * @param props - Sidebar props
 * @param state - Sidebar state (collapse, extraVisible, etc.)
 * @returns Computed width styles
 */
function useSidebarWidth(props: Props, state: SidebarState) {
  return computed(() => {
    const width = props.width === 0 
      ? 0 
      : props.width + (props.isSidebarMixed && props.fixedExtra && state.extraVisible ? props.extraWidth : 0);
    
    const widthPx = `${width}px` as const;
    
    return {
      ...(width === 0 ? { overflow: 'hidden' as const } : {}),
      flex: `0 0 ${widthPx}`,
      marginLeft: props.show ? 0 : `-${widthPx}`,
      maxWidth: widthPx,
      minWidth: widthPx,
      width: widthPx,
    };
  });
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e8992a1 and 96b0c17.

📒 Files selected for processing (2)
  • packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue (1 hunks)
  • packages/@core/ui-kit/layout-ui/src/vben-layout.vue (1 hunks)
🔇 Additional comments (2)
packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue (1)

194-197: LGTM! The width calculation fix addresses the layout issue.

The change correctly handles the case when width is 0, preventing layout disruption in full-screen mode.

Let's verify the fix works across different viewport sizes and collapse states:

✅ Verification successful

Based on the search results, I can now generate the final response. The code shows that the width calculation change is part of a larger layout system that handles different sidebar modes (mixed, collapsed, etc.) consistently across the application.

The width calculation change is correct and consistent with the codebase design.

The search results confirm that:

  • The width === 0 check is necessary for proper collapse behavior in the layout system
  • The width calculation is used in conjunction with isSidebarMixed mode across multiple components
  • The change aligns with the existing layout logic in vben-layout.vue which also handles special cases for width being 0 in mobile and collapsed states
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find related layout tests and viewport handling code

# Search for related layout tests
rg -l "layout.*test" --glob "*.{spec,test}.{ts,js,vue}"

# Search for responsive/viewport related code
ast-grep --pattern 'computed(() => {
  $$$
  width $$$
  $$$
})'

Length of output: 124


Script:

#!/bin/bash
# Let's try a different approach to find layout-related tests and viewport handling

# Search for test files containing 'layout' or 'sidebar'
rg -l "layout|sidebar" --glob "*.{spec,test}.{ts,js,vue}"

# Search for width-related computations in Vue files
rg -A 5 "computed.*width" --glob "*.vue"

# Search for responsive or viewport-related code
rg -A 5 "(responsive|viewport|breakpoint)" --glob "*.{vue,ts}"

# Look for similar width calculations in other components
ast-grep --pattern 'width === 0 ? $$ : $$'

Length of output: 8354


Script:

#!/bin/bash
# Let's search for related layout sidebar components and width calculations

# Search for similar sidebar components
rg -A 10 "layout-sidebar" --glob "*.{vue,ts}"

# Look for width-related style calculations
rg -A 5 "width.*style" --glob "*.vue"

# Search for similar mixed sidebar logic
rg -A 5 "isSidebarMixed" --glob "*.{vue,ts}"

# Look for width-related tests or stories
rg -l "width.*test|sidebar.*test" --glob "*.{spec,test,stories}.{ts,js,vue}"

Length of output: 13871

packages/@core/ui-kit/layout-ui/src/vben-layout.vue (1)

195-195: LGTM! The sidebar visibility logic fix looks correct.

The addition of !props.sidebarHidden condition ensures proper sidebar hiding behavior, which should resolve the mixed menu layout issues in full content mode.

Let's verify the sidebar visibility behavior:

✅ Verification successful

Based on the search results, I can now verify the review comment. The code shows that:

  1. The showSidebar computed property is used to control sidebar visibility and is referenced in multiple places:

    • Template: :show="showSidebar" for sidebar component
    • Used in mainStyle computed property for width calculations
    • Affects header wrapper styling
  2. The isSideMode computed property correctly checks for sidebar-based layouts:

const isSideMode = computed(() =>
  currentLayout.value === 'mixed-nav' ||
  currentLayout.value === 'sidebar-mixed-nav' ||
  currentLayout.value === 'sidebar-nav'
);
  1. The sidebarEnable value is properly used in conjunction with layout mode:
const sidebarEnableState = computed(() => {
  return !isHeaderNav.value && sidebarEnable.value;
});

The sidebar visibility logic is correctly implemented.

The addition of !props.sidebarHidden condition to showSidebar computed property ensures proper sidebar hiding behavior in all layout modes. This change works in harmony with the existing layout mode checks and sidebar enable state.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any other sidebar visibility related logic that might need similar updates

# Search for sidebar visibility related code
rg -A 5 'sidebarHidden|showSidebar|sidebar.*visible' --type vue

# Search for potential layout mode checks
ast-grep --pattern 'computed(() => {
  $$$
  return $_ && $_ && !props.sidebarHidden
  $$$
})'

Length of output: 190


Script:

#!/bin/bash
# Let's try a different approach to search for sidebar-related code

# Search for sidebar-related code without file type restriction
rg -A 5 'sidebarHidden|showSidebar|sidebar.*visible'

# Search for computed properties in .vue files
rg -A 5 'computed\(' --type-add 'vue:*.vue' --type vue

# Search for layout mode related code
rg -A 5 'isSideMode|sidebarEnable' --type-add 'vue:*.vue' --type vue

Length of output: 126392

@anncwb anncwb merged commit ae3f7cb into vbenjs:main Dec 1, 2024
14 checks passed
@anncwb anncwb added the bug Something isn't working label Dec 1, 2024
@mynetfan mynetfan deleted the fix/mixed-menu branch December 3, 2024 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: 双列菜单布局情况下,全屏导致样式错乱
2 participants