Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: 修复表格designConfig配置tooltip不生效 #2923

Closed
wants to merge 0 commits into from

Conversation

hashiqi12138
Copy link
Contributor

@hashiqi12138 hashiqi12138 commented Feb 19, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

配置表格design Config中的tootip字段,theme:dark,表格提示框背景为白色

Issue Number: #2922

What is the new behavior?

配置表格design Config中的tootip字段,theme:dark,表格提示框背景为黑色

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Enhanced tooltip configuration to support a more customizable and consistent tooltip display by intelligently merging user preferences with default settings.

Copy link

coderabbitai bot commented Feb 19, 2025

Walkthrough

This pull request updates the tooltip configuration in the Vue grid component. In the configuration file, the tooltip property key is renamed from theme to effect. In the grid component’s render method, tooltip settings are now merged from the design configuration, global defaults, and component props using Object.assign. These changes adjust how tooltip appearance is determined without affecting core functionalities.

Changes

File(s) Change Summary
packages/vue/src/grid/src/config.ts Renamed the tooltip configuration property from theme: 'dark' to effect: 'dark'
packages/vue/src/grid/src/grid/grid.ts Added code in the render method to merge tooltip configuration from designConfig, global defaults, and component props using Object.assign for flexible setup

Sequence Diagram(s)

sequenceDiagram
    participant R as Render Method
    participant G as GlobalConfig.tooltip
    participant D as DesignConfig.tooltip
    participant P as Props.tooltip
    participant T as Merged Tooltip Config

    R->>G: Retrieve default tooltip config
    R->>D: Retrieve design tooltip config
    R->>P: Retrieve tooltip config from props
    Note over R: Merge configs (precedence: Props > Design > Global)
    R->>T: Create merged tooltip config
    R->>T: Render tooltip using merged config
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • zzcr
  • chenxi-20

Poem

I'm a rabbit with a hop and a code tweak,
Changing theme to effect—now that's sleek.
Merging configs from everywhere in sight,
Rendering tooltips with fresh delight.
Hopping through grids under the moonlight!

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/vue/src/grid/src/config.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue/src/grid/src/grid/grid.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 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 d0254b7 and cc44c8b.

📒 Files selected for processing (2)
  • packages/vue/src/grid/src/config.ts (1 hunks)
  • packages/vue/src/grid/src/grid/grid.ts (1 hunks)
🔇 Additional comments (2)
packages/vue/src/grid/src/config.ts (1)

108-108:

✅ Verification successful

Approve the tooltip property rename from theme to effect.

The change aligns with Vue's tooltip API which uses effect for visual style. This fixes the tooltip configuration issue.

Let's verify if this change is consistent with Vue's tooltip API:


🌐 Web query:

What is the correct property name for tooltip visual style in Vue - theme or effect?

💡 Result:

The correct property name for defining visual styles in Vue tooltips depends on the library being used:

1. Syncfusion Vue Tooltip
Uses cssClass property for custom styling[1][7], allowing CSS class injection:

<ejs-tooltip :cssClass="customtip">

2. Floating Vue
Uses theme property to apply predefined or custom themes[2][6][8]:

<button v-tooltip="{ theme: 'info-tooltip' }">

Themes control styling through associated CSS classes like .v-popper--theme-info-tooltip.

3. Custom CSS Implementations
When building custom tooltips without libraries, direct CSS class binding is typically used[3][4].

Key distinction:

  • theme = Library-specific theming system (Floating Vue)
  • cssClass = Direct CSS class injection (Syncfusion)
  • Neither uses "effect" for core styling - this term typically refers to animation properties when present[10].

Citations:


Tooltip Property Update Approved

The configuration now uses

effect: 'dark'

in packages/vue/src/grid/src/config.ts, which aligns with the tooltip API used by Element UI (where the tooltip component accepts an effect prop with values such as 'dark' or 'light'). This change resolves the tooltip configuration issue as observed.

Note: If a different tooltip library is used (e.g., Floating Vue relies on the theme prop or Syncfusion uses cssClass), please double-check that the underlying tooltip component expects the effect property.

packages/vue/src/grid/src/grid/grid.ts (1)

375-379: LGTM! Proper configuration merge with correct precedence.

The implementation correctly merges tooltip configurations from:

  1. Global defaults (GlobalConfig.tooltip)
  2. Design configuration (designConfig.tooltip)
  3. Component props (props.tooltipConfig)

This ensures user configurations take precedence over defaults.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

@github-actions github-actions bot added the bug Something isn't working label Feb 19, 2025
Copy link

Walkthrough

此PR修复了表格组件中designConfig配置的tooltip不生效的问题。通过将tooltip配置中的theme属性替换为effect,并合并全局配置与用户配置,确保在theme: dark时,表格提示框背景为黑色。

Changes

文件 摘要
packages/vue/src/grid/src/config.ts tooltip配置中的theme属性替换为effect,以确保正确应用主题效果。
packages/vue/src/grid/src/grid/grid.ts 合并designConfig中的tooltip配置,优先使用用户配置,确保提示框背景色正确。

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


Walkthrough

This PR fixes the issue where the tooltip configured in the designConfig table component does not take effect. Make sure that the background of the table prompt box is black when the theme: dark is replaced by effect in the tooltip configuration and merge the global configuration with the user configuration.

Changes

File Summary
packages/vue/src/grid/src/config.ts Replace the theme property in the tooltip configuration with effect to ensure the theme effects are applied correctly.
packages/vue/src/grid/src/grid/grid.ts Merge the tooltip configuration in designConfig, prioritize the user configuration, and ensure that the background color of the prompt box is correct.

Copy link

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants