Skip to content

fix: show validation message as tooltip in compact form #6087

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

Merged
merged 1 commit into from
Apr 30, 2025

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Apr 30, 2025

紧凑模式表单的校验消息将显示为一个tooltip

close: #5633

Summary by CodeRabbit

  • New Features
    • Form fields now display validation errors in a tooltip when in compact mode, improving error visibility without taking up extra space.
  • Chores
    • Updated internal dependencies to include icon support.

Copy link

changeset-bot bot commented Apr 30, 2025

⚠️ No Changeset found

Latest commit: f4e7462

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

Copy link
Contributor

coderabbitai bot commented Apr 30, 2025

Walkthrough

This change updates the form field error message display logic for the @vben-core/form-ui package. When the form is in compact mode and a field is invalid, error messages are now shown in a tooltip using the VbenTooltip component and a CircleAlert icon, instead of being displayed inline. The package.json is also updated to add @vben-core/icons as a dependency, supporting the new icon usage. No changes are made to exported or public entity declarations.

Changes

File(s) Change Summary
packages/@core/ui-kit/form-ui/package.json Added @vben-core/icons as a dependency.
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue Added tooltip-based error display for compact mode using VbenTooltip and CircleAlert icon; updated imports.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FormField
    participant VbenTooltip
    participant CircleAlert

    User->>FormField: Interacts with form in compact mode
    FormField->>FormField: Validates input
    alt Field is invalid and compact mode
        FormField->>VbenTooltip: Render tooltip with FormMessage
        VbenTooltip->>CircleAlert: Display alert icon as trigger
        User->>CircleAlert: Hover/focus icon
        VbenTooltip->>User: Show error message in tooltip
    else Not compact or valid
        FormField->>User: Show inline error message (if not compact)
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix error message overlap in compact mode (#5633)

Suggested reviewers

  • anncwb
  • jinmao88
  • vince292007

Poem

A tooltip hops in, so bright and neat,
No more error overlap at your feet!
With a CircleAlert, the warnings appear,
Compact and clear, the path is sheer.
Dependencies tidy, icons in tow—
The form fields now have a perfect glow!
🐇✨


📜 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 20c15f3 and f4e7462.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • packages/@core/ui-kit/form-ui/package.json (1 hunks)
  • packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)
🔇 Additional comments (5)
packages/@core/ui-kit/form-ui/package.json (1)

41-41: Appropriate dependency added for icon usage

The addition of @vben-core/icons as a dependency is necessary to support the new tooltip-based error display feature, which uses the CircleAlert icon.

packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (4)

8-8: Import added for CircleAlert icon

The import for the CircleAlert icon from @vben-core/icons supports the new tooltip implementation for validation messages.


16-16: Import added for VbenTooltip component

The import for the VbenTooltip component is properly added to the existing imports from @vben-core/shadcn-ui.


359-376: Well-implemented tooltip for validation messages in compact mode

The tooltip implementation effectively addresses the PR objective by displaying validation messages in a tooltip when in compact mode. The implementation:

  1. Only shows when both compact is true and the field is invalid
  2. Uses appropriate positioning (left side)
  3. Includes a reasonable delay duration for better UX
  4. Uses the CircleAlert icon as a clear visual indicator of validation issues

388-388: Conditional rendering of inline validation message

The addition of v-if="!compact" to the Transition component ensures that inline validation messages are only shown when not in compact mode, which is consistent with the tooltip-based approach in compact mode.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@mynetfan mynetfan merged commit add1e61 into vbenjs:main Apr 30, 2025
14 checks passed
@mynetfan mynetfan deleted the fix/compact-form-message branch April 30, 2025 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant