fix: width for ellipsisText tooltip in popover content

[mynetfan]

Description

修复省略文本用在气泡中时，提示弹出层的宽度计算有误的问题

fix #5506

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features
  • Tooltips now adjust their maximum width dynamically based on the rendered element’s size, providing a more responsive and visually refined experience.
• Refactor
  • Improved the underlying logic for computing tooltip dimensions, ensuring optimal display adjustments without altering the overall behavior.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2f3a729

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The change updates the tooltip logic in the ellipsis-text component by incorporating the useElementSize composable from @vueuse/core. Instead of relying on the element’s offsetWidth, the component now uses the reactive eleWidth.value to determine the maximum tooltip width. This adjustment involves updating a condition in a watchEffect and recalculating defaultTooltipMaxWidth based on the new value, enhancing responsiveness.

Changes

File Path	Change Summary
packages/effects/.../ellipsis-text.vue	Integrated useElementSize from @vueuse/core, updated the tooltip width calculation in the watchEffect by replacing offsetWidth with eleWidth.value.

Sequence Diagram(s)

sequenceDiagram
    participant E as EllipsisText Component
    participant U as useElementSize Composable
    participant T as Tooltip Manager

    E->>U: Initialize and bind to element
    U-->>E: Provide reactive eleWidth value
    E->>E: Watch for changes in eleWidth.value
    E->>T: Update tooltip max-width based on eleWidth.value

Loading

Possibly related PRs

• fix(@vben/common-ui): text omission component expansion exception #4139: Modifies tooltip and ellipsis text logic in a similar component, addressing tooltip behavior and text expansion.

Suggested labels

bug

Suggested reviewers

• anncwb
• vince292007

Poem

In a meadow of code where pixels bloom,
I hop 'round components in the digital room.
With eleWidth as my guiding light,
Tooltip magic makes everything just right.
Hoppy trails and bug-free days, I cheer with a twitch and a sway!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/effects/common-ui/src/components/ellipsis-text/ellipsis-text.vue

Oops! Something went wrong! :(

ESLint: 9.19.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5262233 and 2f3a729.

📒 Files selected for processing (1)

• packages/effects/common-ui/src/components/ellipsis-text/ellipsis-text.vue (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Test (windows-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Check (ubuntu-latest)

🔇 Additional comments (3)

packages/effects/common-ui/src/components/ellipsis-text/ellipsis-text.vue (3)

8-8: LGTM! Good choice using useElementSize.

Using useElementSize from @vueuse/core is a better approach for reactive width tracking compared to manually accessing offsetWidth.

---

83-83: LGTM! Clean implementation of useElementSize.

The destructuring of width as eleWidth and passing the ellipsis ref is implemented correctly.

---

87-90: LGTM! Verify the 24px padding is sufficient for all content.

The changes improve reactivity by using eleWidth.value instead of offsetWidth. The added 24px padding should provide space for the tooltip content.

Please verify that:

1. The 24px padding is sufficient for all possible content types
2. The tooltip remains properly aligned with the text in all cases

✅ Verification successful

🌐 Web query:

What is the recommended padding for tooltips in UI design guidelines?

💡 Result:

While UI design guidelines emphasize tooltip clarity and placement, specific numerical padding recommendations are rarely standardized across sources. However, key principles can be inferred from best practices:

1. Internal Padding:

   • Ensure text doesn’t touch tooltip edges. A common approach is using 8–12px internal padding to balance readability and compactness[1][4][7].
   • For multi-line tooltips, maintain consistent vertical spacing (e.g., 4–6px between lines)[2][8].

2. Margins Around Tooltips:

   • Position tooltips with at least 4–8px margins from adjacent UI elements to prevent overlap[3][7][10].
   • Adobe Spectrum explicitly recommends defining a “container padding” value to keep tooltips within viewport boundaries[10].

3. Contextual Adjustments:

   • Increase padding for dense interfaces or smaller screens to enhance readability[4][7].
   • Use arrows with additional spacing (e.g., 2–4px) to visually connect tooltips to their target elements[2][7].

For frameworks like Material Design, follow component-specific guidelines (e.g., default spacing tokens)[5][9]. Always test padding in context to ensure tooltips remain unobtrusive yet legible[1][8].

Citations:

• 1: https://uxdworld.com/tooltip-guidelines/
• 2: https://cieden.com/book/atoms/tooltip/tooltip-design-best-practices
• 3: https://design.procore.com/tooltip
• 4: https://userpilot.com/blog/tooltip-best-practices/
• 5: https://m2.material.io/components/tooltips
• 6: https://app.uxcel.com/courses/ui-components-n-patterns/anatomy-iii-394
• 7: https://userpilot.com/blog/tooltip-ui-design/
• 8: https://www.nngroup.com/articles/tooltip-guidelines/
• 9: https://m3.material.io/components/tooltips/guidelines
• 10: https://spectrum.adobe.com/page/tooltip/

---

Tooltip Padding Verification:
The 24px addition effectively equates to a 12px padding on each side, which aligns well with common UI guidelines recommending 8–12px internal padding. This calculation should provide enough breathing room for typical tooltip content. However, it's advisable to test edge cases (e.g., multi-line tooltips or very dense content) to ensure the tooltip remains properly aligned with the text.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.