fix(components): [upload] make abort param optional by SevenDreamYang · Pull Request #23353 · element-plus/element-plus

SevenDreamYang · 2026-01-08T17:26:39Z

Change the parameter type definition of the abort function to optional

Please make sure these boxes are checked before submitting your PR, thank you!

Make sure you follow contributing guide English | (中文 | Español | Français).
Make sure you are merging your commits to dev branch.
Add some descriptions and refer to relative issues for your PR.

Instructions

When calling the abort function in the upload-content.vue file, the parameters are optional, but in use-handlers.ts, the parameters of the abort function are defined as mandatory parameters, resulting in type mismatch.

Summary by CodeRabbit

New Features
- Upload component's abort functionality is now more flexible, allowing calls without specifying a file.
Documentation
- Updated Upload component documentation to reflect API changes.

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

- Change the parameter type definition of the �bort function to optional

pull-request-triage · 2026-01-08T17:26:46Z

👋 @SevenDreamYang, seems like this is your first time contribution to element-plus.
Please make sure that you have read our guidelines and code of conduct before making a contribution.

github-actions · 2026-01-08T17:26:48Z

coderabbitai · 2026-01-08T17:26:54Z

📝 Walkthrough

Walkthrough

The abort function parameter in the Upload component is made optional across documentation and implementation. The function signature changes from requiring a file parameter to accepting an optional one, allowing the abort method to be called without arguments.

Changes

Cohort / File(s)	Summary
Implementation `packages/components/upload/src/use-handlers.ts`	Function signature updated: `abort(file: UploadFile)` → `abort(file?: UploadFile)` making the file parameter optional
Documentation `docs/en-US/component/upload.md`	Exposes table updated to reflect signature change: `abort(file: UploadFile) => void` → `abort(file?: UploadFile) => void`

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A parameter once bound and constrained,
Now flexible, beautifully unchained,
Abort may stand solo and free,
Optional dancing through the spree,
With a hop and a skip, we declare—
The Upload's grown lighter than air! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: making the abort function parameter optional in the upload component.
Description check	✅ Passed	The description includes the required checklist items, explains the change rationale, references specific files and line numbers, and addresses the type mismatch issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b7d8ea and e653661.

📒 Files selected for processing (2)

docs/en-US/component/upload.md
packages/components/upload/src/use-handlers.ts

🧰 Additional context used

🧬 Code graph analysis (1)

packages/components/upload/src/use-handlers.ts (1)

packages/components/upload/src/upload.ts (1)

UploadFile (31-40)

🔇 Additional comments (2)

docs/en-US/component/upload.md (1)

149-149: LGTM! Documentation correctly reflects the API change.

The abort function signature update accurately documents that the file parameter is now optional, aligning with the implementation change in use-handlers.ts.
packages/components/upload/src/use-handlers.ts (1)
42-44: Optional parameter is correctly implemented and backward compatible.

The abort() method in upload-content.vue properly handles undefined as a parameter:

When called without arguments: aborts all uploads (filter matches all requests)

When called with a specific file: aborts only that file's upload (filter matches by uid)

The implementation uses conditional filtering logic:
const abort = (file?: UploadFile) => {
  const _reqs = entriesOf(requests.value).filter(
    file ? ([uid]) => String(file.uid) === uid : () => true
  )
  _reqs.forEach(([uid, req]) => {
    if (req instanceof XMLHttpRequest) req.abort()
    delete requests.value[uid]
  })
}
The wrapper in use-handlers.ts correctly exposes this with an optional parameter, and the only call site found (remove handler) passes a specific file, which is the expected usage.

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

E66Crisp · 2026-01-09T01:47:10Z

Hi, I think these two functions serve different purposes. The abort in use-handlers.ts is a higher-level wrapper, while upload-content.vue's is the underlying implementation. They don't need to have the same signature. Just my personal opinion.

SevenDreamYang · 2026-01-09T02:43:48Z

Hi, I think these two functions serve different purposes. The abort in use-handlers.ts is a higher-level wrapper, while upload-content.vue's is the underlying implementation. They don't need to have the same signature. Just my personal opinion.

Thank you very much for reviewing. We have a product requirement to abort all ongoing file uploads when the user navigates away from the page.I’ve reviewed the implementation of the abort method: when a file is provided, it aborts only the upload matching file.uid; when no argument is passed, it aborts all pending uploads via the () => true filter.
However, the current TypeScript type definition requires the file parameter to be passed, even though the runtime logic already supports an optional parameter.

pkg-pr-new · 2026-01-09T03:56:26Z

Open in StackBlitz

pnpm add https://pkg.pr.new/element-plus/element-plus@23353

npm i https://pkg.pr.new/element-plus/element-plus@23353

yarn add https://pkg.pr.new/element-plus/[email protected]

commit: 527042d

github-actions · 2026-01-09T04:02:17Z

🧪 Playground Preview: https://element-plus.run/?pr=23353
Please comment the example via this playground if needed.

rzzf

looks good to me

github-actions · 2026-01-09T13:37:30Z

@SevenDreamYang Thanks for your contribution! ❤️

fix(components): [upload] make abort param optional

e653661

- Change the parameter type definition of the �bort function to optional

pull-request-triage Bot assigned SevenDreamYang Jan 8, 2026

pull-request-triage Bot added 1st contribution Their very first contribution Needs Review labels Jan 8, 2026

github-actions Bot added the Contribution::Community label Jan 8, 2026

Merge branch 'dev' into upload-abort-param-optional

527042d

rzzf approved these changes Jan 9, 2026

View reviewed changes

btea approved these changes Jan 9, 2026

View reviewed changes

btea enabled auto-merge (squash) January 9, 2026 13:34

btea merged commit c6e2ed6 into element-plus:dev Jan 9, 2026
16 checks passed

element-bot mentioned this pull request Jan 30, 2026

D2M #23568

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(components): [upload] make abort param optional#23353

fix(components): [upload] make abort param optional#23353
btea merged 2 commits into
element-plus:devfrom
SevenDreamYang:upload-abort-param-optional

SevenDreamYang commented Jan 8, 2026 •

edited

Loading

Uh oh!

pull-request-triage Bot commented Jan 8, 2026

Uh oh!

github-actions Bot commented Jan 8, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jan 8, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

E66Crisp commented Jan 9, 2026

Uh oh!

SevenDreamYang commented Jan 9, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

rzzf left a comment

Uh oh!

Uh oh!

github-actions Bot commented Jan 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

SevenDreamYang commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions

Summary by CodeRabbit

Uh oh!

pull-request-triage Bot commented Jan 8, 2026

Uh oh!

github-actions Bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

E66Crisp commented Jan 9, 2026

Uh oh!

SevenDreamYang commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rzzf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Jan 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

SevenDreamYang commented Jan 8, 2026 •

edited

Loading

github-actions Bot commented Jan 8, 2026 •

edited

Loading

coderabbitai Bot commented Jan 8, 2026 •

edited

Loading

SevenDreamYang commented Jan 9, 2026 •

edited

Loading

pkg-pr-new Bot commented Jan 9, 2026 •

edited

Loading

github-actions Bot commented Jan 9, 2026 •

edited

Loading