fix: fix the issue of Textarea not being able to wrap lines in the form

[gee1k]

fix the issue of Textarea not being able to wrap lines in the form.

Description

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 submissions, allowing for more precise control when the Enter key is pressed.
  • Added functionality to prevent form submission when the Enter key is pressed in a textarea.

• Bug Fixes

  • Resolved issues with default behavior of the Enter key to enhance user experience in forms.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 6a162d3

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

[coderabbitai]

Walkthrough

The changes in the vben-use-form.vue file focus on enhancing event handling related to the Enter key. The handleKeyDownEnter function's signature has been modified to accept a KeyboardEvent parameter, enabling more precise control over event behavior. A new check prevents the default action of the Enter key when the target is a textarea, ensuring that form submission does not occur in that context. The event listener for the Enter key now directly calls this updated function, which manages default behavior internally.

Changes

File Path	Change Summary
packages/@core/ui-kit/form-ui/src/vben-use-form.vue	Updated handleKeyDownEnter to accept a KeyboardEvent and added conditional logic for textarea. Changed event listener from .prevent modifier to a direct function call.

Possibly related PRs

• feat: add form slot for action area #4621: This PR modifies the vben-use-form.vue file to enhance the <FormActions> component by adding new slots, which is directly related to the changes made in the same file regarding event handling and function signatures.
• fix: form required style adjustment #4668: This PR addresses the positioning of required field indicators in forms, which involves changes to the form-field.vue file. Since vben-use-form.vue is likely to interact with form fields, the adjustments in event handling may relate to how required fields are processed.
• fix: form does not take effect in vertical layout #4680: This PR also modifies the form-field.vue file to ensure the labelClass parameter works correctly in vertical layouts, which is relevant to the overall form handling and user interaction in vben-use-form.vue.

Suggested labels

bug

Suggested reviewers

• anncwb
• vince292007

🐇 In the form where bunnies play,
The Enter key now knows the way.
With careful checks, it hops around,
No more submissions when the textarea’s found!
So let us dance and joyfully cheer,
For smoother forms are finally here! 🎉

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[gee1k]

修复由 #4670 带来的 Textarea 无法回车换行的问题

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/@core/ui-kit/form-ui/src/vben-use-form.vue (1)

42-49: Approve changes with a minor suggestion

The changes to handleKeyDownEnter function effectively address the issue with Textarea line wrapping. The new implementation provides more precise control over the Enter key behavior by checking the event target.

Consider adding a type annotation for the event.target check to improve code readability:

- if (event.target instanceof HTMLTextAreaElement) {
+ if ((event.target as HTMLElement).tagName === 'TEXTAREA') {

This change makes the intention clearer and aligns with TypeScript best practices.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 307a71f and 6a162d3.

📒 Files selected for processing (1)

• packages/@core/ui-kit/form-ui/src/vben-use-form.vue (2 hunks)

🧰 Additional context used

🔇 Additional comments (2)

packages/@core/ui-kit/form-ui/src/vben-use-form.vue (2)

59-59: Approve template changes

The update to the @keydown.enter event handler in the template is consistent with the changes made to the handleKeyDownEnter function. Removing the .prevent modifier and directly calling the function allows for more flexible handling of the Enter key event.

---

Line range hint 42-59: Summary of changes and their impact

The changes in this file effectively address the issue of Textarea not being able to wrap lines properly. The handleKeyDownEnter function has been updated to conditionally handle the Enter key event based on the target element, allowing textareas to behave as expected while maintaining the desired behavior for other form elements.

These changes align well with the PR objectives and provide a clean solution to the reported bug. The implementation is straightforward and doesn't introduce any apparent new issues or complexities.