fix: fixed the form component componentProps using the function that did not meet expectations

[anncwb]

Description

fixed #4414

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

  • Enhanced form field component to support shared properties, improving flexibility and reusability.
  • Updated schema structure to include common component properties for better organization.

• Bug Fixes

  • Maintained existing functionality for form item visibility and rendering despite structural changes.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7531e3f

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 introduced in this pull request enhance the form-field.vue and form.vue components by adding a new property, commonComponentProps, to the Props interface and updating the computedSchema return type. These modifications allow for a more modular approach to component properties, improving the organization of schema data and enabling better handling of shared properties across different form fields.

Changes

File Path	Change Summary
packages/@core/ui-kit/form-ui/src/form-render/...	Added commonComponentProps: MaybeComponentProps to Props interface in form-field.vue. Updated computedSchema return type in form.vue to include commonComponentProps in the schema structure.

Possibly related PRs

• fix: when the form is opened repeatedly, the state is unexpectedly stroyed #4406: Modifies the onOpenChange method of the modal to reset the form's state, potentially impacting how commonComponentProps are used in form components.
• fix: the onOpenChange event for the modal component does not work as expected #4425: Addresses the onOpenChange event handling in the modal, which could relate to the enhancements in form structure and behavior from this PR.

Suggested labels

bug

Suggested reviewers

• vince292007

Poem

In fields of code where rabbits play,
New props have hopped in, brightening the day.
With common traits, our forms align,
A dance of data, so clean and fine.
Let’s celebrate this joyful change,
In our UI garden, we’ll freely range! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 834cb4c and 7531e3f.

Files selected for processing (2)

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

Additional comments not posted (6)

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

9-10: LGTM!

The imports are valid and used appropriately in the code.

---

74-121: LGTM!

The changes to the computedSchema computed property are valid and improve the organization of the schema data structure. The updated return type enhances the schema's structure by consolidating common component properties directly within the schema mapping. The existing functionality related to form rendering and item visibility is maintained.

The changes align with the AI-generated summary.

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

4-4: LGTM!

The import statement for MaybeComponentProps type is correctly added.

---

Line range hint 29-46: Looks good!

The new prop commonComponentProps of type MaybeComponentProps is correctly added to the Props interface and included in the defineProps function.

---

141-141: LGTM!

Spreading commonComponentProps into computedProps correctly includes the common properties in the final set of props.

---

Line range hint 1-298: Overall, the changes in the form-field.vue file look good!

The component has a clear structure and follows best practices. The addition of commonComponentProps and its usage in the component enhances flexibility and reusability. The computed properties and methods are well-defined and serve their purposes effectively. The template section utilizes conditional rendering and slots for customization.

No major issues or improvements are identified based on the provided code. Great job!

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.