fix: sidebar scrolling does not meet expectations

[anncwb]

Description

fixed #4214

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

  • Introduced scroll locking in the sidebar to enhance user interaction by preventing background scrolling when the sidebar is active.

• Improvements

  • Adjusted the z-index of a styled element to better manage its visibility and layering in relation to other components on the page.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 884b406

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

[coderabbitai]

Walkthrough

The changes involve a modification to the useContentStyle function, adjusting the zIndex property, and the introduction of scroll-locking functionality within the layout-sidebar.vue component. The scroll-lock feature enhances user interaction by preventing body scrolling when hovering over the sidebar, ensuring a more controlled experience.

Changes

Files	Change Summary
packages/@core/composables/src/use-content-style.ts packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue	The zIndex property in useContentStyle was changed from 1000 to 150. Added scroll-locking behavior in layout-sidebar.vue, controlling document body scroll on mouse enter/leave.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant Body

    User->>Sidebar: Mouse enters
    Sidebar->>Body: Lock scroll
    User->>Sidebar: Mouse leaves
    Sidebar->>Body: Unlock scroll

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Bug: Sidebar scroll locks body content (#4214)	✅

🐇 In a sidebar snug and tight,
Scrolls are locked, oh what a sight!
Content stays, no sliding away,
Happy users dance and play!
A change so sweet, a joy to bring,
Thank you for this lovely thing! 🎉

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54a622a and 884b406.

Files selected for processing (2)

• packages/@core/composables/src/use-content-style.ts (1 hunks)
• packages/@core/ui-kit/layout-ui/src/components/layout-sidebar.vue (4 hunks)

Additional comments not posted (3)

packages/@core/composables/src/use-content-style.ts (1)

31-31: Verify the impact of the zIndex change.

The zIndex has been changed from 1000 to 150. Ensure this change aligns with the intended design and does not introduce any visual issues or conflicts with other elements.

Run the following script to verify the impact of the zIndex change:

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

220-220: Verify the impact of the scroll locking behavior.

The handleMouseenter function locks the scroll when the mouse enters the sidebar area. The handleMouseleave function unlocks the scroll when the mouse leaves the sidebar area. Ensure these changes align with the intended design and do not introduce any usability issues.

Run the following script to verify the impact of the scroll locking behavior:

Also applies to: 231-231

---

7-8: Verify the impact of the scroll locking behavior.

The useScrollLock function has been added to lock the scroll when the mouse enters the sidebar area and unlock it when the mouse leaves. Ensure this change aligns with the intended design and does not introduce any usability issues.

Run the following script to verify the impact of the scroll locking behavior:

Also applies to: 107-107