NotificationsYou must be signed in to change notification settings
Fork4.4k
Star38.5k

fix: tooltip position on edge of screen#34518

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

admirhusic wants to merge3 commits intoappsmithorg:release

base:release

Choose a base branch

fromadmirhusic:fix/tooltip-position-fix

Open

fix: tooltip position on edge of screen#34518

admirhusic wants to merge3 commits intoappsmithorg:releasefromadmirhusic:fix/tooltip-position-fix

Conversation

Copy link

admirhusic commentedJun 26, 2024•
edited by coderabbitaibot
Loading

Description

Fixes tooltip on input label when touching edges of the screen.

Fixes#34445

Automation

/ok-to-test tags=""

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

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

Nikhil-Nandagopal I haven't created tests since this is a small change. Let me know if this case is required to be tested. :)

Summary by CodeRabbit

New Features
- Enhanced tooltip behavior to prevent overflow and enable flipping, improving the positioning and visibility of tooltips.

admirhusic added3 commits

June 25, 2024 22:02

fix(Tooltip): Ensure tooltip stays within viewport boundaries

d9a1838

- Added Popper.js modifiers to prevent tooltip from overflowing viewport edges- Enabled 'preventOverflow' to restrict tooltip within the viewport- Enabled 'flip' to automatically reposition tooltip if there is insufficient space- Docs:https://floating-ui.com/docs/flip#flipResolves:appsmithorg#34445

Merge branch 'refs/heads/release' into fix/tooltip-position-fix

1362d70

Merge remote-tracking branch 'origin/release' into fix/tooltip-positi…

72b8045

…on-fix

Copy link

Contributor

coderabbitaibot commentedJun 26, 2024•
edited
Loading

Walkthrough

TheTooltipComponent has been updated to enhance tooltip positioning. Specifically, the tooltip now uses thepreventOverflow andflip modifiers to avoid being cut off in full-screen mode. These changes aim to ensure better visibility and positioning of tooltips.

Changes

File	Change Summary
`app/client/packages/design-system/widgets-old/src/Tooltip/index.tsx`	Modified`TooltipComponent` to enable`preventOverflow` with`boundariesElement: "viewport"` and activate the`flip` modifier.

Assessment against linked issues

Objective	Addressed	Explanation
Fix tooltip cutting in fullscreen (#34445)	✅

Poem

In a world of widgets tall and proud,
Tooltips danced and sang aloud.
No longer cut by screen's embrace,
They flip and flow with style and grace.
Now in fullscreen, they stand so bright,
Overflow no more, they're just right. 🐇✨

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?

Tips

Chat

There are 3 ways to chat withCodeRabbit:

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 Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a.coderabbit.yaml file to the root of your repository.
Please see theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
Join ourDiscord Community to get help, request features, and share feedback.
Follow us onX/Twitter for updates and announcements.

coderabbitaibot reviewed

Jun 26, 2024

View reviewed changes

Copy link

Contributor

coderabbitaibot 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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between6f67dbd and72b8045.

Files selected for processing (1)

app/client/packages/design-system/widgets-old/src/Tooltip/index.tsx (1 hunks)

Additional comments not posted (2)

app/client/packages/design-system/widgets-old/src/Tooltip/index.tsx (2)
78-84:Enhancements to Tooltip Positioning Logic
The modifications to thepreventOverflow andflip modifiers are correctly implemented to address the tooltip cutoff issue described in the linked issue. SettingpreventOverflow toenabled: true withboundariesElement: "viewport" ensures that tooltips do not extend beyond the viewport, which is crucial for tooltips near the screen edges. Additionally, enabling theflip modifier allows the tooltip to reposition itself to remain visible, which is a smart use of the Popper.js library's capabilities.
These changes are well-aligned with the PR objectives to improve tooltip visibility and positioning in edge cases.
78-84:Verify Integration with Existing Modifiers
Given the integration of new modifiers with existing ones (...props.modifiers), it's critical to ensure that there are no conflicts or unexpected behaviors when these modifiers are combined with others that might be passed as props.

app/client/packages/design-system/widgets-old/src/Tooltip/index.tsx

Comment on lines +78 to +84

		preventOverflow:{
		enabled:true,
		boundariesElement:"viewport",
		},
		flip:{
		enabled:true,
		},

Copy link

Contributor

coderabbitaibotJun 26, 2024

Choose a reason for hiding this comment

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

Consider Adding Comments for Clarity

While the code changes are effective, adding comments explaining why these specific modifiers were chosen could be beneficial for future maintenance. This is especially important as tooltips are a common UI component and these changes might have nuanced impacts on different parts of the application.

      preventOverflow: {+       // Enable to prevent the tooltip from overflowing the viewport        enabled: true,+       // Set the boundary element to the viewport to ensure visibility        boundariesElement: "viewport",      },      flip: {+       // Enable flipping to adjust tooltip position dynamically        enabled: true,      },

Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	preventOverflow:{
	enabled:true,
	boundariesElement:"viewport",
	},
	flip:{
	enabled:true,
	},
	preventOverflow:{
	// Enable to prevent the tooltip from overflowing the viewport
	enabled:true,
	// Set the boundary element to the viewport to ensure visibility
	boundariesElement:"viewport",
	},
	flip:{
	// Enable flipping to adjust tooltip position dynamically
	enabled:true,
	},