search

ReactTooltip / react-tooltip

React Tooltip Component
https://react-tooltip.com/
MIT License
3.59k stars 528 forks source link

feat: support for disabled tooltip callback #1211

Closed nareshpingale closed 2 months ago

nareshpingale commented 2 months ago

Addresse #1210

Usage:

   <button
      data-tooltip-id="anchor-select"
      data-tooltip-content="this content is different"
      data-tooltip-dynamic="true"
      style={{
        maxWidth: '200px',
        overflow: 'hidden',
        textOverflow: 'ellipsis',
        whiteSpace: 'nowrap',
      }}
    >
      Anchor select with dynamic tooltip and a very long label to test overflow
    </button>
    <button data-tooltip-id="anchor-select" data-tooltip-dynamic="true">
      Anchor select with dynamic tooltip
    </button>
    <button data-tooltip-id="anchor-select">Anchor select without dynamic tooltip</button>
  </p>
  <Tooltip
    id="anchor-select"
    disableTooltip={(anchor) => {
      const { scrollWidth, offsetWidth } = anchor as HTMLElement
      if (anchor?.getAttribute('data-tooltip-dynamic') && scrollWidth <= offsetWidth) {
        return true
      }

      return false
    }}
  >
    Tooltip content
  </Tooltip>

https://github.com/user-attachments/assets/932b76f2-8733-465a-bf02-8970da36435c

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes introduce a new optional prop, disableTooltip, that allows developers to conditionally disable tooltips for specific anchors. This enhancement improves flexibility and control over tooltip visibility across various components, including the Tooltip, TooltipController, and their respective TypeScript interfaces, ensuring seamless integration within the existing codebase.

Changes

Files Change Summary
src/components/Tooltip/Tooltip.tsx, Added disableTooltip prop to the Tooltip component for conditional tooltip disabling based on anchor logic.
src/components/TooltipTypes.d.ts Introduced disableTooltip method in ITooltip interface for controlling tooltip display behavior per anchor.
src/components/TooltipController/TooltipController.tsx, Added disableTooltip prop to TooltipController, impacting tooltip rendering according to this new functionality.
src/components/TooltipControllerTypes.d.ts Added disableTooltip method to ITooltipController interface for managing tooltip visibility based on anchor state.
docs/docs/options.mdx Documented the new disableTooltip function, detailing its use for controlling tooltip visibility per anchor.
src/test/tooltip-props.spec.js Added tests for disableTooltip prop behavior in TooltipProps, validating rendering logic based on its return value.

Poem

🐇 In the garden where tooltips play,
A new prop hops in to brighten the day!
"Disable me," it cheerfully sings,
Allowing more joy to the tooltip flings.
With anchors that dance and twirl with grace,
Conditional whispers now take their 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
nareshpingale commented 2 months ago

@gabrieljablonski do let me know if we need to update /examples for this. Also if everything looks fine at first glance will start adding changes to /docs.

nareshpingale commented 2 months ago