refactor(components): [dialog] use type-based definitions by lw56777 · Pull Request #23432 · element-plus/element-plus

lw56777 · 2026-01-18T05:09:16Z

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.

修复：#23399

Summary by CodeRabbit

Refactor
- Consolidated dialog prop definitions into explicit, strongly typed public contracts to improve type safety.
- Introduced centralized default values for dialog content and dialog props, applied across components for consistent behavior.
- Marked legacy/older prop shapes as deprecated while preserving runtime behavior and backward compatibility.

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

pull-request-triage · 2026-01-18T05:09:20Z

👋 @lw56777, 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-18T05:09:25Z

coderabbitai · 2026-01-18T05:09:34Z

📝 Walkthrough

Walkthrough

Adds exported TypeScript prop interfaces (DialogContentProps, DialogProps), a dialogContentPropsDefaults constant, deprecates legacy public alias DialogPropsPublic, and migrates Vue components to typed defineProps<...>() with withDefaults(...) for defaults.

Changes

Cohort / File(s)	Summary
Prop interfaces & defaults `packages/components/dialog/src/dialog-content.ts`, `packages/components/dialog/src/dialog.ts`	Adds exported `DialogContentProps` and `DialogProps` (extends `DialogContentProps`), introduces `dialogContentPropsDefaults`, adds Vue `Component` type for `closeIcon`, consolidates type imports, and marks legacy `DialogPropsPublic` as deprecated.
Component prop usage `packages/components/dialog/src/dialog-content.vue`, `packages/components/dialog/src/dialog.vue`	Replace runtime prop objects with `defineProps<...>()` + `withDefaults(...)`; import type-only interfaces and `dialogContentPropsDefaults`; remove direct use of `dialogContentProps`/`dialogProps`; emits remain unchanged.

Sequence Diagram(s)

(omitted — refactor/typing only)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

refactor(components): [alert] use type-based definitions #23401 — similar refactor introducing exported prop interfaces and switching components to defineProps<T>() with withDefaults.
refactor(components): [tag] use type-based definitions #23421 — same pattern: replace runtime prop objects with typed interfaces and defaults in components.
refactor(components): [timelineItem] use type-based definitions #23479 — closely related code-level refactor migrating prop definitions to exported TypeScript interfaces and default constants.

Suggested reviewers

btea
keeplearning66

Poem

🐇 I nudged props from night to light,
Typed them neat and set defaults right.
Deprecated echoes softly fade,
New interfaces hop into the glade.
🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main refactoring: converting dialog component props from runtime definitions to type-based definitions.
Description check	✅ Passed	The description includes the required checklist items (all checked) and references issue `#23399`, but lacks substantive details about what was changed.
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

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-18T05:11:01Z

Open in StackBlitz

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

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

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

commit: ccd1787

github-actions · 2026-01-18T06:51:01Z

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

rzzf · 2026-01-18T08:08:35Z

https://github.com/element-plus/element-plus/actions/runs/21107548227/job/60701234788?pr=23432

Can you take a look at the failed CI?

github-actions · 2026-01-20T09:35:50Z

@lw56777 Thanks for your contribution! ❤️

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

bf8ece6

pull-request-triage Bot assigned lw56777 Jan 18, 2026

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

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

btea mentioned this pull request Jan 18, 2026

Refactor Component Props to type-based declarations #23399

Closed

64 tasks

Merge branch 'dev' into refactor/dialog-ComponentProps-#23399

8af59fb

lw56777 added 3 commits January 18, 2026 17:23

Merge branch 'dev' into refactor/dialog-ComponentProps-#23399

0d3ba71

fix: test fail

26490f2

Merge branch 'dev' into refactor/dialog-ComponentProps-#23399

14eea95

btea reviewed Jan 18, 2026

View reviewed changes

Comment thread packages/components/dialog/src/dialog-content.ts Outdated

Comment thread packages/components/dialog/src/dialog-content.vue Outdated

Comment thread packages/components/dialog/src/dialog.ts

lw56777 added 3 commits January 19, 2026 10:06

fix: btea

86df888

Merge branch 'dev' into refactor/dialog-ComponentProps-#23399

2de168c

Merge branch 'dev' into refactor/dialog-ComponentProps-#23399

b0b43ed

btea reviewed Jan 19, 2026

View reviewed changes

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

keeplearning66 reviewed Jan 19, 2026

View reviewed changes

Comment thread packages/components/dialog/src/dialog-content.ts Outdated

lw56777 and others added 3 commits January 20, 2026 09:57

fix: btea and rainbow

676d648

Merge branch 'dev' into refactor/dialog-ComponentProps-#23399

b5ca9fb

refactor: tweaks

ccd1787

rzzf approved these changes Jan 20, 2026

View reviewed changes

rzzf mentioned this pull request Jan 20, 2026

refactor(components): [drawer] use type-based definitions #23484

Merged

btea approved these changes Jan 20, 2026

View reviewed changes

btea merged commit 46dc569 into element-plus:dev Jan 20, 2026
19 of 21 checks passed

lw56777 deleted the refactor/dialog-ComponentProps-#23399 branch January 20, 2026 10:26

element-bot mentioned this pull request Jan 30, 2026

D2M #23568

Merged

3 tasks

Uh oh!

Conversation

lw56777 commented Jan 18, 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!

pull-request-triage Bot commented Jan 18, 2026

Uh oh!

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

Uh oh!

Uh oh!

coderabbitai Bot commented Jan 18, 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 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

rzzf commented Jan 18, 2026

Uh oh!

Uh oh!

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!

4 participants

lw56777 commented Jan 18, 2026 •

edited by coderabbitai Bot

Loading

github-actions Bot commented Jan 18, 2026 •

edited

Loading

coderabbitai Bot commented Jan 18, 2026 •

edited

Loading

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

edited

Loading

github-actions Bot commented Jan 18, 2026 •

edited

Loading