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: disabledOnChangeListener not work in form #5146

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 15, 2024

Description

修复disabledOnChangeListener在form中不生效的问题

fix #5144

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

    • Improved event handling for form fields, enhancing clarity in event binding.
    • Streamlined creation of component properties for better performance.
  • Bug Fixes

    • Adjusted logic for determining field requirements to align with new rules structure.
  • Refactor

    • Enhanced structure of event binding logic for better maintainability.

Copy link

changeset-bot bot commented Dec 15, 2024

⚠️ No Changeset found

Latest commit: c5a2dde

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 15, 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/@core/ui-kit/form-ui/src/form-render/form-field.vue

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 pull request focuses on modifying the form-field.vue file to improve event handling and component property creation for form fields. The changes primarily involve refining the fieldBindEvent function to conditionally include onInput and onChange event handlers based on specific flags. The createComponentProps function has been updated to more precisely manage the inclusion of event-related properties, ensuring a more streamlined approach to creating component props.

Changes

File Change Summary
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue - Refactored fieldBindEvent function to conditionally return event handlers
- Updated createComponentProps to use Reflect.has for checking property existence
- Adjusted logic for handling event listeners and component properties

Assessment against linked issues

Objective Addressed Explanation
Fix ElInputTag component value binding in forms [#5144]
Resolve inconsistent event handling for form components

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

🐰 In the realm of forms, where fields dance and sway,
Event handlers now leap in a more elegant way!
With props refined and listeners clear,
Our code now whispers, "No bug shall appear!"
A rabbit's delight in clean, crisp design! 🎉


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.

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

🧹 Nitpick comments (2)
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (2)

234-237: LGTM! Consider adding a comment for clarity.

The changes correctly implement the disabling of input and change event handlers when no bindEventField is present. This fixes the core issue where disabledOnChangeListener wasn't working.

Consider adding a comment to explain the fallback behavior:

+  // Fallback case when no bindEventField is present
   return {
     ...(disabledOnInputListener ? { onInput: undefined } : {}),
     ...(disabledOnChangeListener ? { onChange: undefined } : {}),
   };

Line range hint 239-252: LGTM! Consider adding type safety for event handlers.

The changes correctly handle the precedence of event handlers from computedProps using Reflect.has. This ensures proper overriding of event handlers when specified in component props.

Consider adding type safety for the event handlers:

+type EventHandler = (e: any) => void;
+
 function createComponentProps(slotProps: Record<string, any>) {
   const bindEvents = fieldBindEvent(slotProps);
 
   const binds = {
     ...slotProps.componentField,
     ...computedProps.value,
     ...bindEvents,
     ...(Reflect.has(computedProps.value, 'onChange')
-      ? { onChange: computedProps.value.onChange }
+      ? { onChange: computedProps.value.onChange as EventHandler }
       : {}),
     ...(Reflect.has(computedProps.value, 'onInput')
-      ? { onInput: computedProps.value.onInput }
+      ? { onInput: computedProps.value.onInput as EventHandler }
       : {}),
   };
 
   return binds;
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ce4af37 and c5a2dde.

📒 Files selected for processing (1)
  • packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1 hunks)
🔇 Additional comments (1)
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1)

Line range hint 234-252: Verify the fix addresses the reported issue.

The changes look good and directly address the reported issue in #5144. Let's verify that the fix works as expected across different form field types.

✅ Verification successful

The search results show that the disabledOnChangeListener and disabledOnInputListener functionality is consistently implemented across the form-ui module. Let me verify one more aspect to ensure the fix is complete.


The fix for disabledOnChangeListener is properly implemented and verified

The implementation is correct and consistent across the codebase:

  • The feature is properly typed in types.ts as part of FormCommonConfig
  • Default configuration in config.ts sets both listeners to true by default
  • The fix in form-field.vue correctly implements the disabling logic by setting handlers to undefined
  • The implementation maintains proper precedence with computedProps values
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other form field components that might be affected by this change

# Look for form field components that use onChange or onInput events
ast-grep --pattern 'onChange: $_' 
ast-grep --pattern 'onInput: $_'

# Look for other instances where these listeners might be disabled
rg "disabledOnChangeListener|disabledOnInputListener"

Length of output: 1782


Script:

#!/bin/bash
# Check the configuration and type definitions to ensure the fix aligns with the intended behavior

# Check the default configuration
cat packages/@core/ui-kit/form-ui/src/config.ts

# Check the type definitions
cat packages/@core/ui-kit/form-ui/src/types.ts

Length of output: 10445

@mynetfan mynetfan merged commit 22c1f86 into vbenjs:main Dec 15, 2024
14 checks passed
@mynetfan mynetfan deleted the fix/form-disabled-change branch December 15, 2024 16:57
@github-actions github-actions bot locked and limited conversation to collaborators Jan 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: ElInputTab el-input-tag 组件在表单中的使用问题
1 participant