Fix #577: [New Feature] Added Multiple direction support for Tooltip …

[anihar2003]

This PR adds support for cardinal and compound directions in the Tooltip component by extending the placement prop. The supported directions include:

Cardinal Directions:
top, bottom, left, right .

Compound Directions:
top-start, top-end, bottom-start, bottom-end,
left-start, left-end, right-start, right-end.

Key Changes:

Updated Popper and Tooltip components to support these directions using the placement prop.
Integrated Floating UI middleware to handle placements dynamically, ensuring proper positioning based on viewport constraints.
Tested the functionality with various placements and alignment strategies.

Summary by CodeRabbit

• New Features

  • Expanded placement options for the Popper and Tooltip components, now supporting twelve positioning values.
  • Added default values for the label and placement props in the Tooltip component, enhancing configurability.

• Bug Fixes

  • Updated Tooltip stories to reflect the new placement prop for accurate rendering.

[coderabbitai]

Walkthrough

The changes in this pull request involve updates to the Popper and Tooltip components. The PopperProps type has been expanded to include a total of twelve placement options, enhancing the positioning flexibility of the Popper component. Similarly, the Tooltip component now accepts a placement prop with the same options, along with default values for the label and placement properties. Additionally, the Storybook configuration for the Tooltip component has been updated to reflect these changes.

Changes

File	Change Summary
src/components/tools/Popper/Popper.tsx	Expanded PopperProps type placement from 3 to 12 values for enhanced positioning flexibility.
src/components/ui/Tooltip/Tooltip.tsx	Added placement prop to TooltipProps, updated function signature to include default values.
src/components/ui/Tooltip/stories/Tooltip.stories.js	Updated Tooltip usage in Storybook to include placement prop set to 'left'.

Possibly related issues

• [New Feature] Add Multiple direction support for Tooltip #577: The changes address the feature request for adding multiple direction support for the Tooltip by introducing a placement prop with various options.

Poem

🐇 In the garden where tooltips play,
New placements bloom, bright as day.
From top to left, they dance and sway,
A rabbit's joy in a flexible way!
With every pop, a label to say,
"Hello, dear friend, come out and play!" 🌼

---

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>, 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

src/components/ui/Tooltip/Tooltip.tsx (1)

25-25: Fix spacing around the assignment operator.

ESLint correctly identified a spacing issue.

-const Tooltip = ({ children, label="hello", placement = 'top', ...props }: TooltipProps) => {
+const Tooltip = ({ children, label = "hello", placement = 'top', ...props }: TooltipProps) => {

🧰 Tools

🪛 eslint

[error] 25-25: Operator '=' must be spaced.

(space-infix-ops)

src/components/ui/Tooltip/stories/Tooltip.stories.js (1)

11-13: Enhance stories to showcase all placement options.

While the current example demonstrates the 'left' placement, it would be valuable to showcase all cardinal and compound directions to help users understand the full capabilities.

Consider adding:

1. A story for each cardinal direction (top, right, bottom, left)
2. Examples of compound directions (e.g., top-start, bottom-end)
3. Interactive controls to let users experiment with different placements

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 08cc93b and 507cd68.

📒 Files selected for processing (3)

• src/components/tools/Popper/Popper.tsx (1 hunks)
• src/components/ui/Tooltip/Tooltip.tsx (1 hunks)
• src/components/ui/Tooltip/stories/Tooltip.stories.js (1 hunks)

🧰 Additional context used

🪛 eslint

src/components/ui/Tooltip/Tooltip.tsx

[error] 25-25: Operator '=' must be spaced.

(space-infix-ops)

🔇 Additional comments (3)

src/components/tools/Popper/Popper.tsx (2)

24-36: LGTM! Comprehensive placement options added.

The expanded placement options align well with Floating UI's capabilities and the PR objectives. The type definition correctly includes all cardinal and compound directions.

---

Line range hint 6-7: Address collision handling TODOs before merging.

The TODO comments indicate potential issues with collision handling. This could affect the reliability of the new placement options, especially in constrained viewport scenarios.

Let's verify the collision handling behavior:

Consider:

1. Testing edge cases with viewport constraints
2. Documenting the expected fallback behavior
3. Implementing proper collision resolution strategies

src/components/ui/Tooltip/Tooltip.tsx (1)

9-21: LGTM! Placement type matches Popper component.

The placement options are correctly synchronized with the Popper component's type definition.

[kotAPI]

Wanna add more examples to test it out? Just for sanity sake