Update TooltipControllerTypes.d.ts

[devyanshyadav]

Allow JSX.Element in tooltip content and html props

• Update ITooltipController interface
• content and html props now accept string | JSX.Element
• Improves flexibility for adding React elements in TypeScript

Summary by CodeRabbit

• New Features
  • Tooltip content can now include JSX elements, allowing for richer and more dynamic tooltip displays.

[coderabbitai]

Walkthrough

The ITooltipController interface in the TooltipControllerTypes.d.ts file has been enhanced to provide greater flexibility in content rendering. The content and html properties can now accept either a string or JSX element, and the function signature for render has been updated accordingly. This allows for more dynamic and rich tooltip content.

Changes

Files	Change Summary
src/components/TooltipController/TooltipControllerTypes.d.ts	Updated ITooltipController interface: content and html properties can now be string or JSX element; updated render function signature

Sequence Diagram

silently ignored due to the simple nature of changes

Poem

🐰 Beneath the code, in Tooltip's delight,
Content and HTML now shine more bright.
Either string or JSX, they flex with grace,
Tooltip anew, in every space.
Render now refines the scene,
As elements blend where once strings had been.
🖱️✨

---

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

[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 d23da63 and 7b033f0.

Files selected for processing (1)

• src/components/TooltipController/TooltipControllerTypes.d.ts (1 hunks)

Files not reviewed due to errors (1)

• src/components/TooltipController/TooltipControllerTypes.d.ts (no review received)

[gabrieljablonski]

I'll have to check if this doesn't break anything (we might assume content is always a string somewhere), but at first glance it technically doesn't add anything new to the tooltip (just some convenience, I guess), since you can already pass JSX as children to the tooltip, or with the render prop. For instance:

<Tooltip>
  <MyTooltipContent />
</Tooltip>

We're already doing some planning for V6 of the tooltip, so we might integrate this, or just drop the content prop entirely in favor of children, so there's less redundancy in existing features (html is already deprecated).

Not sure yet what we'll do, but thanks for the suggestion!