fix(form): export SubmitterProps type

[leshalv]

Summary by CodeRabbit

发布说明

• 新功能
  • 新增 SubmitterProps 类型导出，完善表单组件的公开接口，增强 API 可访问性。

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[gemini-code-assist]

Summary of Changes

Hello @leshalv, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a minor but important fix by exporting a key type definition. The change ensures that developers using the form library have full access to the SubmitterProps type, facilitating better type-checking and integration when building custom form submission logic. This enhances the overall developer experience and promotes stronger type safety within applications.

Highlights

• Type Export: The SubmitterProps type, which defines properties for form submission components, is now explicitly exported from the main form module. This makes the type publicly accessible, improving type visibility and reusability for consumers of the library.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[coderabbitai]

📝 Walkthrough

高层概述

在 src/form/index.tsx 中添加了新的公开类型导出 SubmitterProps，该类型从 ./BaseForm/Submitter 模块重新导出。仅涉及类型导出，无其他功能性改动。

变更清单

内聚组 / 文件	变更摘要
类型导出扩展 src/form/index.tsx	添加 SubmitterProps 类型导出，从 ./BaseForm/Submitter 重新导出

代码审查工作量评估

🎯 1 (轻微) | ⏱️ ~3 分钟

关注要点：

• 确认 SubmitterProps 类型定义在 ./BaseForm/Submitter 模块中存在
• 验证重新导出不会引入循环依赖问题

庆祝诗句

🐰 在导出的花园里，新类型绽放，
SubmitterProps 乘风起航，
简洁优雅，无需多言，
类型安全，从此不同。 ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	PR标题清晰准确地描述了主要变更，即导出SubmitterProps类型，与代码摘要完全一致。
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 2caf967 and 428c060.

📒 Files selected for processing (1)

• src/form/index.tsx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{tsx,jsx}

📄 CodeRabbit inference engine (.cursor/rules/react.mdc)

**/*.{tsx,jsx}: Use early returns whenever possible to make the code more readable.
Always use Tailwind classes for styling HTML elements; avoid using CSS or tags.
Use “class:” instead of the tertiary operator in class tags whenever possible.
Use descriptive variable and function/const names. Also, event functions should be named with a “handle” prefix, like “handleClick” for onClick and “handleKeyDown” for onKeyDown.
Implement accessibility features on elements. For example, a tag should have a tabindex=“0”, aria-label, on:click, and on:keydown, and similar attributes.
Use consts instead of functions, for example, “const toggle = () =>”. Also, define a type if possible.

Files:

• src/form/index.tsx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build
• GitHub Check: build
• GitHub Check: build (20.x, ubuntu-latest)
• GitHub Check: Analyze (javascript)

🔇 Additional comments (1)

src/form/index.tsx (1)

8-8: 导出已验证无误。

已确认 SubmitterProps 类型在 src/form/BaseForm/Submitter/index.tsx 第 15 行正确导出。导出语句 export type SubmitterProps<T = Record<string, any>> = { 与索引文件中的导入方式相符。多个文件（如 StepsForm、ModalForm、LoginForm、DrawerForm 等）已在使用此类型，该添加是必要的。

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request correctly exports the SubmitterProps type. My review includes one suggestion for improving maintainability by using the existing barrel file pattern for BaseForm components. This would make the module's export structure more consistent and easier to manage.

[gemini-code-assist]

For consistency and better maintainability, it would be preferable to export SubmitterProps through the BaseForm's barrel file (src/form/BaseForm/index.ts), similar to how other BaseForm-related types are handled.

This would involve two steps:

1. Add export * from './Submitter'; to src/form/BaseForm/index.ts.
2. Then, in this file (src/form/index.tsx), you could modify the existing export type for ./BaseForm to include SubmitterProps and remove the newly added line. The modified line would look like this: export type { LightWrapperProps, ProFormInstance, SubmitterProps } from './BaseForm';

This approach keeps the module's public API consolidated and easier to manage by avoiding direct dependencies on nested files from the top-level index file.