refactor(components): [transfer] use type-based definitions by wjp980108 · Pull Request #23460 · element-plus/element-plus

wjp980108 · 2026-01-19T04:15:42Z

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

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.

Summary by CodeRabbit

Refactor
- Added explicit public prop interfaces for Transfer and marked older prop aliases as deprecated.
- Tightened prop typings across transfer utilities, requiring specific prop subsets for stronger compile-time checks.
Chores
- Components now supply explicit default values for nested props and stabilize initialization without runtime behavior changes.

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

github-actions · 2026-01-19T04:15:50Z

coderabbitai · 2026-01-19T04:15:54Z

📝 Walkthrough

Walkthrough

Replaced runtime ExtractPropTypes-based prop exports with explicit TypeScript interfaces for Transfer and TransferPanel; tightened composable function parameter types to require specific prop subsets; migrated components to type-based defineProps<...>() with withDefaults and nested defaults; marked legacy runtime prop objects as deprecated.

Changes

Cohort / File(s)	Summary
Composables — stricter prop signatures `packages/components/transfer/src/composables/use-check.ts`, `packages/components/transfer/src/composables/use-computed-data.ts`, `packages/components/transfer/src/composables/use-move.ts`	Narrowed exported function parameter types to required/omitted subsets of the new `TransferProps` (e.g., `Required<Pick<...>>`, `Required<Omit<...>>`); only TypeScript signatures changed.
Composables — props alias surface `packages/components/transfer/src/composables/use-props-alias.ts`	Parameter type changed from `{ props: TransferPropsAlias }` to accept `TransferProps` directly; internal initialization still uses `Required<TransferPropsAlias>` and merging behavior unchanged.
Transfer panel types & runtime props `packages/components/transfer/src/transfer-panel.ts`	Added exported `TransferPanelProps` interface describing panel public shape; retained `transferPanelProps` runtime definition but annotated it as deprecated; exported `TransferPanelPropsPublic` remains with deprecation note.
Transfer panel component props usage `packages/components/transfer/src/transfer-panel.vue`	Switched from `defineProps(transferPanelProps)` to `defineProps<TransferPanelProps>()` wrapped with `withDefaults()`; removed `transferPanelProps` import and provided nested defaults via `mutable`.
Transfer component types & runtime props `packages/components/transfer/src/transfer.ts`	Introduced exported `TransferProps` interface for public API; marked the existing `transferProps` and ExtractPropTypes-based alias as deprecated and exposed a deprecated `TransferPropsPublic` alias.
Transfer component props usage `packages/components/transfer/src/transfer.vue`	Replaced `defineProps(transferProps)` with `withDefaults(defineProps<TransferProps>(), {...})`; added explicit defaults including nested `props` via `mutable` and removed reliance on `transferProps` import.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

refactor(components): [carousel] use type-based definitions #23430 — similar refactor tightening composable parameter types and replacing runtime prop-based typing with explicit TypeScript interfaces.

Suggested reviewers

btea

Poem

🐇 I nudge the props, make types align,
I tuck in defaults, one small design,
Deprecation carrots in a row,
I hop through code where type winds blow,
A tiny rabbit, tidy and fine.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main refactor: moving Transfer component from runtime prop definitions to type-based definitions.
Description check	✅ Passed	The PR description references the related issue (`#23399`) and confirms all three checklist items were completed, meeting template requirements.
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.}

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

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

pkg-pr-new · 2026-01-19T04:17:24Z

Open in StackBlitz

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

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

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

commit: 68c2937

wjp980108 · 2026-01-19T04:30:51Z

CI is having problems again. Will it retry on its own, or do I need to contact management for assistance? @rzzf

btea · 2026-01-19T06:09:00Z

It's okay, don't worry about it, this has nothing to do with the changes you made to the code.

github-actions · 2026-01-19T06:44:18Z

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

github-actions · 2026-01-20T06:34:47Z

@wjp980108 Thanks for your contribution! ❤️

…plus#23460) * refactor(components): [transfer] use type-based definitions * fix: update * fix: ts * fix: update * refactor: tweaks --------- Co-authored-by: btea <[email protected]> Co-authored-by: rzzf <[email protected]>

refactor(components): [transfer] use type-based definitions

9db5b10

pull-request-triage Bot assigned wjp980108 Jan 19, 2026

pull-request-triage Bot added the Needs Review label Jan 19, 2026

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

btea mentioned this pull request Jan 19, 2026

Refactor Component Props to type-based declarations #23399

Closed

64 tasks

btea added 2 commits January 19, 2026 14:23

fix: update

40a885a

fix: ts

0c38c9e

rzzf approved these changes Jan 19, 2026

View reviewed changes

btea reviewed Jan 19, 2026

View reviewed changes

Comment thread packages/components/transfer/src/transfer.vue Outdated

fix: update

f61cac1

rzzf requested changes Jan 19, 2026

View reviewed changes

Comment thread packages/components/transfer/src/transfer.vue Outdated

refactor: tweaks

68c2937

rzzf approved these changes Jan 20, 2026

View reviewed changes

btea approved these changes Jan 20, 2026

View reviewed changes

btea merged commit 27eb9ea into element-plus:dev Jan 20, 2026
17 of 20 checks passed

wjp980108 deleted the refactor/transfer-type branch January 20, 2026 07:24

element-bot mentioned this pull request Jan 30, 2026

D2M #23568

Merged

3 tasks

coderabbitai Bot mentioned this pull request Feb 16, 2026

refactor(components): [transfer] make component generic #23666

Merged

coderabbitai Bot mentioned this pull request Jun 2, 2026

feat(components): [transfer] add virtual scroll support #24367

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(components): [transfer] use type-based definitions#23460

refactor(components): [transfer] use type-based definitions#23460
btea merged 5 commits into
element-plus:devfrom
wjp980108:refactor/transfer-type

wjp980108 commented Jan 19, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

github-actions Bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jan 19, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

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

edited

Loading

Uh oh!

wjp980108 commented Jan 19, 2026

Uh oh!

btea commented Jan 19, 2026

Uh oh!

github-actions Bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

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

Uh oh!

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

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

Uh oh!

Uh oh!

wjp980108 commented Jan 19, 2026

Uh oh!

btea commented Jan 19, 2026

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wjp980108 commented Jan 19, 2026 •

edited by coderabbitai Bot

Loading

github-actions Bot commented Jan 19, 2026 •

edited

Loading

coderabbitai Bot commented Jan 19, 2026 •

edited

Loading

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

edited

Loading

github-actions Bot commented Jan 19, 2026 •

edited

Loading