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(vuerenderless/grid): 支持designConfig中配置tooltip #2977

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

hashiqi12138
Copy link
Contributor

@hashiqi12138 hashiqi12138 commented Feb 26, 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?

Issue Number: #2922

What is the new behavior?

支持designConfig中配置tooltip;默认为 GlobalConfig 中的tooltip配置;

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • The tooltip now features a refreshed, light effect appearance instead of the previous dark theme.
    • Tooltip behavior has been enhanced by consolidating configuration settings for a more consistent visual experience.

Copy link

coderabbitai bot commented Feb 26, 2025

Walkthrough

This PR updates the tooltip configuration in the Vue grid package. In config.ts, the property theme is replaced with effect and its default value is updated from 'dark' to 'light'. In addition, grid.ts now initializes a new tooltipConfig in the Vue component by merging tooltip settings from global, design, and local configurations via Object.assign. No changes have been made to the exported entities.

Changes

File Change Summary
packages/vue/src/.../config.ts Replaced tooltip.theme with tooltip.effect and updated its value from 'dark' to 'light'.
packages/vue/src/.../grid/grid.ts Added initialization for tooltipConfig by merging configurations from GlobalConfig, designConfig, and local props.

Sequence Diagram(s)

sequenceDiagram
    participant Grid
    participant GlobalConfig
    participant DesignConfig
    participant LocalProps
    Note over Grid: Initialize tooltip configuration
    Grid->>GlobalConfig: Retrieve tooltip config
    Grid->>DesignConfig: Retrieve tooltip config
    Grid->>LocalProps: Retrieve local tooltipConfig (if any)
    Grid->>Grid: Merge all config via Object.assign
    Grid->>Display: Apply final tooltip configuration
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • gimmyhehe
  • zzcr

Poem

I'm just a bunny with a code-filled delight,
Hopping through changes from dark into light.
Merging configs with a skip and a bound,
Ensuring tooltips are perfectly sound.
With whiskers a-twitch and a joyful cheer,
I celebrate this update far and near! 🐇✨

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

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.

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 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 397b0ab and 02ba28c.

📒 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: Update of tooltip configuration property

The change from theme: 'dark' to effect: 'light' aligns with modern tooltip APIs. This is a necessary update to support the tooltip configuration in the designConfig.

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

375-376: Good implementation for tooltip configuration support

This implementation correctly enables tooltip configuration through designConfig by merging configurations from three sources in order of increasing precedence:

  1. Global defaults from GlobalConfig.tooltip
  2. Design-specific settings from designConfig.tooltip
  3. Direct props from props.tooltipConfig

The approach follows the same pattern used for other configurations in the codebase (e.g., optimization).

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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 26, 2025
Copy link

Walkthrough

This PR addresses a bug fix by enabling tooltip configuration within designConfig. The tooltip defaults to the configuration in GlobalConfig if not specified in designConfig.

Changes

Files Summary
packages/vue/src/grid/src/config.ts Changed tooltip theme from 'dark' to 'light'.
packages/vue/src/grid/src/grid/grid.ts Initialized tooltip configuration by merging GlobalConfig, designConfig, and existing props.tooltipConfig.

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.

1 participant