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

increase zIndex of modal sidebar to fix resize bug #4860

Merged
merged 1 commit into from
Sep 27, 2024

Conversation

imanjra
Copy link
Contributor

@imanjra imanjra commented Sep 27, 2024

What changes are proposed in this pull request?

increase zIndex of modal sidebar to fix resize bug

How is this patch tested? If it is not, please explain why.

By resizing the sidebar in modal

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features

    • Introduced theme-based styling for the Resizable component in the InteractiveSidebar, enhancing its visual integration with Material-UI.
  • Bug Fixes

    • Improved the zIndex handling for the Resizable component when a modal is active, ensuring proper layering in the UI.

@imanjra imanjra requested review from sashankaryal and a team September 27, 2024 18:17
Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Walkthrough

The changes involve the addition of the useTheme hook from Material-UI in the Sidebar.tsx file. This allows the InteractiveSidebar component to access theme properties, specifically modifying the zIndex of the Resizable component based on the modal state. When modal is true, the zIndex is set to a value derived from the Material-UI theme; otherwise, it remains undefined.

Changes

File Change Summary
app/packages/core/src/components/Sidebar/Sidebar.tsx Introduced useTheme hook to access Material-UI theme properties; modified zIndex of Resizable based on modal state.

Possibly related PRs

  • fix modal navigation bug #4803: The changes in this PR involve the Modal component, which may interact with the Resizable component in the Sidebar, particularly in terms of z-index and modal behavior.

Suggested labels

bug

Suggested reviewers

  • sashankaryal

Poem

In the sidebar where we play,
A theme was added, bright as day.
With zIndex set, it hops so high,
Like a rabbit leaping through the sky!
Resizable joy, in modal's embrace,
A stylish change, a happy place! 🐇✨


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.

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)
app/packages/core/src/components/Sidebar/Sidebar.tsx (1)

710-713: LGTM: Effective use of MUI theme for z-index

The addition of the style prop to the Resizable component effectively addresses the resize bug mentioned in the PR objectives. The conditional setting of zIndex for modal mode is a good approach.

Consider extracting the style object to a separate constant for improved readability:

const resizableStyle = {
  borderTopRightRadius: 8,
  ...(modal && { zIndex: muiTheme.zIndex.tooltip + 1 }),
};

Then use it like this:

<Resizable
  // ... other props
  style={resizableStyle}
>

This change would make the component props more concise and easier to read.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 81037fa and 20adb47.

📒 Files selected for processing (1)
  • app/packages/core/src/components/Sidebar/Sidebar.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/core/src/components/Sidebar/Sidebar.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

🔇 Additional comments (2)
app/packages/core/src/components/Sidebar/Sidebar.tsx (2)

14-14: LGTM: Good use of import aliasing

The addition of the useTheme import from Material-UI and aliasing it as useMUITheme is a good practice. It avoids naming conflicts with the existing useTheme import and clearly indicates the source of the theme hook.


697-697: LGTM: Proper use of MUI theme hook

The addition of the muiTheme constant using the useMUITheme hook is correct and follows React best practices. The naming is clear and consistent with the import alias.

Copy link
Contributor

@sashankaryal sashankaryal left a comment

Choose a reason for hiding this comment

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

lgtm! 🚀 🎖️

@sashankaryal sashankaryal merged commit 3e1a9b1 into release/v1.0.0 Sep 27, 2024
11 checks passed
@sashankaryal sashankaryal deleted the bugfix/modal-sidebar-resize branch September 27, 2024 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants