fix: Peek overlay overflowing in side by side

[albinAppsmith]

Description

Peek overlay popover was getting cut off in the left side. This PR fix this issue.

Fixes #33370

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9059955985
Commit: a7a9a10
Cypress dashboard url: Click here!

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

[coderabbitai]

Walkthrough

Walkthrough

The update introduces a function getLeftPosition in PeekOverlayPopup.tsx to calculate the optimal left position of the peak overlay, ensuring it remains visible within the viewport in a split view setup. This function dynamically adjusts the position based on the element's right boundary to prevent cutoffs.

Changes

File Path	Change Summary
.../CodeEditor/PeekOverlayPopup/PeekOverlayPopup.tsx	Added getLeftPosition function to adjust overlay position

Assessment against linked issues

Objective	Addressed	Explanation
Prevent peak overlay cutoff in split view (#33370)	✅

The changes align well with the objective of ensuring the peak overlay is fully visible in split view scenarios, addressing the issue comprehensively.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d1c9bde and a7a9a10.

Files selected for processing (1)

• app/client/src/components/editorComponents/CodeEditor/PeekOverlayPopup/PeekOverlayPopup.tsx (2 hunks)

Additional comments not posted (2)

app/client/src/components/editorComponents/CodeEditor/PeekOverlayPopup/PeekOverlayPopup.tsx (2)

99-103: Ensure getLeftPosition handles extreme cases.

The new function getLeftPosition calculates the left position based on the right position of an element. It's crucial to ensure that this function handles cases where the right position might be extremely large, potentially causing the overlay to be positioned incorrectly. Consider adding boundary checks or using a more robust method to calculate the left position.

---

118-118: Validate dynamic positioning logic.

The dynamic positioning logic in the style attribute of the div uses the getLeftPosition function to set the left style. It's important to validate this logic under different screen sizes and configurations to ensure the overlay is always visible and not cut off.

Verification successful

---

The dynamic positioning logic in the PeekOverlayPopup component is centered around the getLeftPosition function, which calculates the left style property based on the props.position. This function is crucial for ensuring that the overlay is positioned correctly across different screen sizes. Given the specific usage of this function in setting the left property, it appears that the positioning logic is appropriately implemented to handle dynamic screen sizes.

• File: app/client/src/components/editorComponents/CodeEditor/PeekOverlayPopup/PeekOverlayPopup.tsx
  • Line 118: Usage of getLeftPosition to dynamically set the left style based on props.position.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify the dynamic positioning logic in different screen sizes and configurations.

# Test: Simulate different screen sizes and check if the overlay is positioned correctly.
rg --type typescript $'PeekOverlayPopUpContent'

Length of output: 81

---

---

Script:

#!/bin/bash
# Correcting the script to search for 'PeekOverlayPopUpContent' in TypeScript files.
rg 'PeekOverlayPopUpContent' --glob '*.ts' --glob '*.tsx'

Length of output: 309

---

---

Script:

#!/bin/bash
# Extracting the implementation of PeekOverlayPopUpContent from PeekOverlayPopup.tsx
rg 'PeekOverlayPopUpContent' -A 20 --glob 'PeekOverlayPopup.tsx'

Length of output: 4706

---

---

Script:

#!/bin/bash
# Searching for the usage of 'getLeftPosition' within PeekOverlayPopup.tsx to understand its role in dynamic positioning.
rg 'getLeftPosition' --glob 'PeekOverlayPopup.tsx'

Length of output: 337

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration 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.

[albinAppsmith]

/build-deploy-preview skip-test=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9059961163.
Workflow: On demand build Docker image and deploy preview.
skip-tests: . env: .
PR: 33376.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-33376.dp.appsmith.com

[hetunandu]

/build-deploy-preview

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9061053695.
Workflow: On demand build Docker image and deploy preview.
skip-tests: . env: .
PR: 33376.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-33376.dp.appsmith.com

[hetunandu]

Why are we not using the Popover here and its ability to avoid / contain within certain HTML elements. The absolute positioning feels like we would need to handle it whenever dimensions change

[albinAppsmith]

This change requires a design overlook cause popover comes with it's on padding shadow and all... Will create a task and assign to Design team.