perf: expose the formApi for a login form

[anncwb]

Description

close #4780

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

Release Notes

• New Features

  • Enhanced form handling across authentication components with a unified form API.
  • Introduced new methods to expose form API for better integration with parent components.

• Bug Fixes

  • Streamlined toolbar management in the grid component for improved maintainability.

• Chores

  • Updated various package dependencies to their latest versions for improved performance and compatibility.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 3c14f88

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]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes updates to various components and configuration files within the project. Key changes involve the addition of new dependencies in the package.json for the @vben-core/shared package, modifications to form handling in several Vue components (code-login.vue, forget-password.vue, login.vue, register.vue), and enhancements to toolbar management in use-vxe-grid.vue. The pnpm-workspace.yaml file also reflects updates to package versions. The overall focus is on improving form API exposure and maintaining package compatibility.

Changes

File Path	Change Summary
packages/@core/base/shared/package.json	Added dependencies: @types/lodash.get and lodash.get. Modified publishConfig for type definitions.
packages/effects/common-ui/src/ui/authentication/code-login.vue	Renamed destructured variable to formApi. Added defineExpose for getFormApi.
packages/effects/common-ui/src/ui/authentication/forget-password.vue	Updated destructuring to formApi. Added defineExpose for getFormApi.
packages/effects/common-ui/src/ui/authentication/login.vue	Changed destructuring to formApi. Added defineExpose for getFormApi.
packages/effects/common-ui/src/ui/authentication/register.vue	Renamed destructured variable to formApi. Added defineExpose for getFormApi.
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue	Added constants TOOLBAR_ACTIONS and TOOLBAR_TOOLS. Updated computed properties to use new constants.
pnpm-workspace.yaml	Updated versions for multiple packages and added @types/lodash.get.

Assessment against linked issues

Objective	Addressed	Explanation
Expose formApi for login form (related to #4780)	✅
Update form handling logic to utilize formApi (related to #4780)	✅
Ensure backward compatibility with existing props and structure (related to #4780)	✅

Possibly related PRs

• fix: when the form is opened repeatedly, the state is unexpectedly stroyed #4406: Addresses form state management, related to improvements in form handling.
• fix: fixed the form component componentProps using the function that did not meet expectations #4426: Enhances form component properties, connecting with updates in form functionalities.
• fix: when the api returns 401, the page is refreshed not as expected #4440: Involves error handling in authentication, relevant to validation aspects in the main PR.
• feat: add sliding verification to the login form #4461: Introduces a new component for form verification, aligning with enhancements in form functionalities.
• feat: add submitOnEnter configuration to form #4670: Adds a submitOnEnter feature to forms, directly related to discussed form functionalities.
• fix: form does not take effect in vertical layout #4680: Fixes layout issues in forms, relevant to changes in form structure and behavior.

Suggested labels

enhancement

Suggested reviewers

• vince292007

Poem

In the code where bunnies hop,
New forms and tools, we never stop!
With formApi shining bright,
Our components take to flight.
Dependencies updated, all in line,
Hopping forward, feeling fine! 🐇✨

---

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.