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: element plus validate failed style #5130

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 13, 2024

Description

修复ElementPlus表单缺少校验失败的样式

fix #5128

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
    • Introduced a new CSS class for improved visual feedback on form validation errors.
    • Enhanced styles for various form elements, including inputs, checkboxes, and radio buttons, to indicate validation errors more effectively.

Copy link

changeset-bot bot commented Dec 13, 2024

⚠️ No Changeset found

Latest commit: eaba227

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 Dec 13, 2024

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/styles/src/ele/index.css

Oops! Something went wrong! :(

ESLint: 9.16.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)

Walkthrough

The changes in this pull request introduce a new CSS class .form-valid-error to the index.css file. This class enhances the visual representation of form validation errors by applying specific styles to various form elements, including box shadows and border modifications for input types like select, radio, and checkbox. These adjustments ensure consistency with the expected styles as outlined in the Element Plus documentation.

Changes

File Change Summary
packages/styles/src/ele/index.css Added .form-valid-error class for styling validation errors.

Assessment against linked issues

Objective Addressed Explanation
Ensure form validation styles are consistent (#5128)

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

In the world of forms, so bright and fair,
A new style appears, with utmost care.
Errors now shine, in danger's hue,
Guiding the users, with colors so true.
A hop and a skip, validation's delight,
With each little change, our forms feel just right! 🐇✨


📜 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 b09c0a7 and eaba227.

📒 Files selected for processing (1)
  • packages/styles/src/ele/index.css (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/styles/src/ele/index.css

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. (Experiment)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
packages/styles/src/ele/index.css (3)

7-9: LGTM! Consider adding a color variable comment.

The implementation correctly applies the validation error style to Element Plus select components using box-shadow.

Consider adding a comment about the color variable:

 .el-select .el-select__wrapper {
+    /* Uses Element Plus's danger color for validation errors */
     box-shadow: 0 0 0 1px var(--el-color-danger) inset;
 }

12-14: Consider combining similar input and select styles.

The input styles are identical to the select styles. Consider combining them for better maintainability.

-/** select 选择器的样式 */
-.el-select .el-select__wrapper {
-  box-shadow: 0 0 0 1px var(--el-color-danger) inset;
-}
-
-/** input 选择器的样式 */
-.el-input .el-input__wrapper {
-  box-shadow: 0 0 0 1px var(--el-color-danger) inset;
-}
+/** select和input 选择器的样式 */
+.el-select .el-select__wrapper,
+.el-input .el-input__wrapper {
+  box-shadow: 0 0 0 1px var(--el-color-danger) inset;
+}

5-36: Well-structured implementation of form validation error styles.

The approach of using a single .form-valid-error class to handle all form validation styles is clean and maintainable. It properly integrates with Element Plus's design system by:

  1. Using Element Plus's color variables
  2. Following Element Plus's component structure
  3. Maintaining consistent styling across different form components

Consider documenting the usage of this class in the component documentation to help other developers understand when and how to apply these validation styles.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7fbf7b1 and b09c0a7.

📒 Files selected for processing (1)
  • packages/styles/src/ele/index.css (1 hunks)
🔇 Additional comments (2)
packages/styles/src/ele/index.css (2)

17-20: LGTM! Correct implementation of radio/checkbox error styles.

The styles correctly apply validation error borders to radio and checkbox components, maintaining consistency with Element Plus's design system.


22-35: LGTM! Comprehensive handling of button group borders.

The implementation correctly handles border styles for both radio and checkbox button groups, ensuring proper visual separation and error indication.

Let's verify we haven't missed any Element Plus form components that might need error styles:

✅ Verification successful

Element Plus form components error styles are comprehensively covered

Based on the search results, the error styles in packages/styles/src/ele/index.css cover all the basic form input components that require validation states:

  • Select inputs (.el-select)
  • Text inputs (.el-input)
  • Radio buttons and groups (.el-radio, .el-radio-button)
  • Checkboxes and groups (.el-checkbox, .el-checkbox-button)

The implementation consistently uses --el-color-danger for error states across all components, and properly handles special cases like button group borders. Other form components like sliders, date pickers, etc., were not found in the codebase, suggesting they're either not used or styled through a different mechanism.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for Element Plus form-related components in the codebase
# that might need validation error styles

# Look for El* form components in template files
rg -t vue "el-(form|input|select|radio|checkbox|switch|slider|time|date|rate|color|transfer)" -l

# Look for form validation related code
rg "form.*valid|valid.*form" -t vue -l

Length of output: 195


Script:

#!/bin/bash
# Search for Element Plus form-related components in the codebase
# Let's try without file type filtering since vue type isn't recognized

# Look for El* form components
rg "el-(form|input|select|radio|checkbox|switch|slider|time|date|rate|color|transfer)"

# Look for form validation related code
rg "form.*valid|valid.*form"

# Also check CSS files for related Element Plus form styles
rg "\.el-(form|input|select|radio|checkbox|switch|slider|time|date|rate|color|transfer)" --type css

Length of output: 8445

@mynetfan mynetfan merged commit 0410f1e into vbenjs:main Dec 13, 2024
14 checks passed
@mynetfan mynetfan deleted the fix/ele-validor-style branch December 13, 2024 07:33
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.

Bug: web-ele中,使用VbenForm,表单验证与element-plus官网样式不一致
1 participant