feat: add examples: form-upload

[yuhldr]

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

  • Introduced file upload functionality in the form, allowing users to upload image files (.png, .jpg, .jpeg) with progress tracking and error handling.
  • Added a new API endpoint for handling file uploads.
  • Displayed uploaded file URLs and provided clear feedback on upload success or failure.

• Localization

  • Added new English and Chinese translations for upload-related messages.

[coderabbitai]

Walkthrough

A new file upload feature has been implemented across the backend mock API and frontend playground. The backend mock now exposes an /api/upload endpoint that verifies access tokens and returns a static image URL upon success. The playground frontend introduces a new upload_file utility for uploading files, updates the form schema to include an image upload field, and enhances the form submission logic to handle upload results, display localized messages, and process both successful and failed uploads. English and Chinese localization files are updated with new entries for upload-related messages, and the API route list is updated to include the new upload endpoint.

Changes

File(s)	Change Summary
apps/backend-mock/api/upload.ts	Added a new API endpoint handler for /api/upload that verifies access tokens and returns a static image URL.
apps/backend-mock/routes/[...].ts	Added /api/upload to the list of API routes in the HTML response.
playground/src/api/examples/upload.ts	Added upload_file function to handle file uploads with progress, error, and success callbacks.
playground/src/locales/langs/en-US/examples.json playground/src/locales/langs/zh-CN/examples.json	Added new localization keys for upload error, upload URLs, file label, and upload image button text in English and Chinese.
playground/src/views/examples/form/basic.vue	Updated form schema to add an image upload field, integrated upload_file, and enhanced submission logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend (Form)
    participant upload_file API
    participant Backend /api/upload

    User->>Frontend (Form): Selects image and submits form
    Frontend (Form)->>upload_file API: Calls upload_file({ file, ... })
    upload_file API->>Backend /api/upload: Uploads file with token
    Backend /api/upload-->>upload_file API: Returns static image URL (if authorized)
    upload_file API-->>Frontend (Form): onSuccess or onError callback
    Frontend (Form)->>Frontend (Form): Processes upload results
    Frontend (Form)-->>User: Shows success or error message

Loading

Suggested reviewers

• jinmao88

Poem

A bunny with files to send,
Hops to the backend—let uploads ascend!
With tokens checked and URLs in tow,
Success or error, the user will know.
Now forms can handle images bright,
In every language, left and right!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (4)

apps/backend-mock/api/upload.ts (1)

9-13: Consider handling actual file upload rather than returning a static URL.

The current implementation returns a fixed image URL instead of actually processing uploaded files. While sufficient for demonstration purposes, consider enhancing this to process real file uploads for production use.

Also, the commented-out error response on line 12 should be removed or implemented properly if error scenarios testing is needed.

 return useResponseSuccess({
   url: 'https://unpkg.com/@vbenjs/[email protected]/source/logo-v1.webp',
 });
-// return useResponseError("test")

playground/src/api/examples/upload.ts (1)

1-25: Good implementation of the upload functionality.

The upload_file function provides a clean interface for handling file uploads with proper progress tracking, success callbacks, and error handling.

However, I have a few suggestions for improvement:

1. The onSuccess callback accepts data: any which limits type safety. Consider defining a specific response type.
2. The progress reporting is very basic (only 0% and 100%). If the underlying requestClient.upload supports real-time progress updates, consider passing them through.

-  onSuccess?: (data: any, file: File) => void;
+  onSuccess?: (data: { url: string, [key: string]: any }, file: File) => void;

playground/src/views/examples/form/basic.vue (2)

357-376: Solid upload result handling with proper status checking.

The code effectively separates successful and failed uploads, giving appropriate user feedback through localized messages.

Consider adding these safety improvements:

1. Use optional chaining when accessing response.url in case the structure varies:

-  ...doneFiles.map((file) => file.response.url),
+  ...doneFiles.map((file) => file.response?.url || file.name),

2. Avoid type casting with a more specific form values interface:

-function onSubmit(values: Record<string, any>) {
-  const files = toRaw(values.files) as UploadFile[];
+interface FormValues {
+  files: UploadFile[];
+  [key: string]: any;
+}
+
+function onSubmit(values: FormValues) {
+  const files = toRaw(values.files);

---

377-381: Consider consolidating success messages.

The code shows two success messages when uploads succeed: one for the upload URLs and another for form values. This might confuse users.

 if (failedFiles.length === 0) {
   message.success({
-    content: `${$t('examples.form.upload-urls')}: ${msg}`,
+    content: `${$t('examples.form.upload-urls')}: ${msg}\n${$t('examples.form.form-values')}: ${JSON.stringify(values)}`,
   });
+  return;
 } else {
   message.error({
     content: `${$t('examples.form.upload-error')}: ${msg}`,
   });
   return;
 }

-message.success({
-  content: `form values: ${JSON.stringify(values)}`,
-});

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bf7496f and 5563c22.

📒 Files selected for processing (6)

• apps/backend-mock/api/upload.ts (1 hunks)
• apps/backend-mock/routes/[...].ts (1 hunks)
• playground/src/api/examples/upload.ts (1 hunks)
• playground/src/locales/langs/en-US/examples.json (1 hunks)
• playground/src/locales/langs/zh-CN/examples.json (1 hunks)
• playground/src/views/examples/form/basic.vue (3 hunks)

🔇 Additional comments (4)

playground/src/locales/langs/en-US/examples.json (1)

21-23: Good addition of localization keys for the new upload feature.

The new localization entries support the file upload functionality with appropriate error and success messaging. The keys are descriptive and follow the existing naming convention.

apps/backend-mock/routes/[...].ts (1)

10-10: Properly added new upload API endpoint to the routes list.

The upload endpoint is now discoverable alongside other API routes in the mock service.

playground/src/locales/langs/zh-CN/examples.json (1)

24-26: Complete and consistent localization for both languages.

The Chinese translations are appropriate and match the English counterparts, ensuring a consistent user experience across languages.

apps/backend-mock/api/upload.ts (1)

1-8: Authentication handling is properly implemented.

The endpoint correctly verifies user authentication using JWT token before processing the upload request, enhancing security.

[bo-Chou]

是否有图片预览，最终可能这样会比较优雅，当然，我说的不仅是头像： #5448

[jinmao88]

机器人有一些优化 请调整一下

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8f49c23

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

[yuhldr]

机器人有一些优化 请调整一下

已调整

[yuhldr]

是否有图片预览，最终可能这样会比较优雅，当然，我说的不仅是头像： #5448

默认就支持 listType，以添加：点击设置表单值，可以看到

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

playground/src/views/examples/form/basic.vue (1)

336-358: Upload component implementation looks good.

The Upload component is well configured with proper constraints (image types only, single file) and correctly uses the custom upload handler with appropriate display settings.

The previous review comments about file extension format and localization have been addressed correctly.

🧹 Nitpick comments (1)

playground/src/views/examples/form/basic.vue (1)

364-385: Well-implemented file upload handling logic.

The submission handler does a good job of:

1. Separating successful uploads from failed ones
2. Generating appropriate success/error messages
3. Preventing form submission when uploads fail
4. Transforming file objects to URLs for final submission

One small suggestion to enhance error handling:

- const failedFiles = files.filter((file) => file.status !== 'done');
+ const failedFiles = files.filter((file) => file.status !== 'done');
+ const errorMessages = failedFiles.map((file) => 
+   `${file.name}: ${file.error?.message || $t('examples.form.unknown-error')}`
+ );

This would provide more specific error information when available.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f227b44 and 8f49c23.

📒 Files selected for processing (1)

• playground/src/views/examples/form/basic.vue (4 hunks)

🔇 Additional comments (2)

playground/src/views/examples/form/basic.vue (2)

2-15: Great job with well-organized import statements.

The necessary imports for file upload functionality are correctly organized, with proper type definitions (UploadFile), Vue utilities (toRaw), the custom upload handler, and localization function.

---

398-405: Good implementation of example file preset.

The form preset logic correctly demonstrates how to populate the file upload field with an existing file, which is helpful for edit scenarios where an image already exists.

[hgx98]

这个是不是不能做成类似Textarea那种样式？就是Label在左上方对齐的。目前来看这个文件上传是左侧居中对齐的

[hgx98]

这个是不是不能做成类似Textarea那种样式？就是Label在左上方对齐的。目前来看这个文件上传是左侧居中对齐的

[yuhldr]

这个是不是不能做成类似Textarea那种样式？就是Label在左上方对齐的。目前来看这个文件上传是左侧居中对齐的

可以问问ai，这个我没尝试过

[WhiteGIT]

@yuhldr
可以看看后台要给回什么数据格式吗？ 我按文档的例子，默认取到了好多不想要的数据

[yuhldr]

@WhiteGIT

你的data嵌套重复了，另外就是得到一堆是正常的，那是upload默认的，在 “response”里解析真正的url

{"url": "xxxx"}

vue-vben-admin/apps/backend-mock/api/upload.ts

Lines 9 to 11 in b985ff0

	return useResponseSuccess({
	url: 'https://unpkg.com/@vbenjs/[email protected]/source/logo-v1.webp',
	});

[WhiteGIT]

@yuhldr 好的，谢谢。还有个问题 url: 'https://unpkg.com/@vbenjs/[email protected]/source/logo-v1.webp'，返回数据已经改成这样了，上传成功，直接点图片预览是空白

[QizhouYang]

ERROR: Invalid prop: type check failed for prop "fileList". Expected Array, got Object ，