refactor(components): [steps] use type-based definitions by SevenDreamYang · Pull Request #23433 · element-plus/element-plus

SevenDreamYang · 2026-01-18T05:11:52Z

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.

ref #23399

Summary by CodeRabbit

Refactor
- Unified and clarified public prop typings for Step and Steps and added an explicit step status type.
Bug Fixes / Stability
- Stricter prop typing and updated default prop values to reduce runtime surprises and improve consistency.
Chores
- Deprecated old prop export aliases and added migration guidance to use the new typed interfaces.

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

github-actions · 2026-01-18T05:12:00Z

coderabbitai · 2026-01-18T05:12:05Z

📝 Walkthrough

Walkthrough

Replaces runtime ExtractPropTypes-based exported prop aliases with explicit TypeScript interfaces (StepProps, StepsProps, StepsStatus), converts Vue imports to type-only, updates .vue components to defineProps<...>() with withDefaults(...), and adds deprecation notes for old aliases.

Changes

Cohort / File(s)	Summary
Public type declarations `\`packages/components/steps/src/item.ts``,` `packages/components/steps/src/steps.ts``	Added exported interfaces `StepProps`, `StepsProps`, and `StepsStatus`; removed `ExtractPropTypes`-based exported aliases; switched Vue imports to type-only; added deprecation comments for the old alias exports.
Component props migration `\`packages/components/steps/src/item.vue``,` `packages/components/steps/src/steps.vue``	Replaced value-based `stepProps`/`stepsProps` usage with type-only imports; changed `defineProps(propObject)` to `withDefaults(defineProps<...>(), {...})`; updated internal typings (e.g., `IStepsInject.props` → `Required<StepsProps>`).

Sequence Diagram(s)

(omitted — changes are type/public-API and do not introduce new multi-component runtime control flow)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

refactor(components): [tag] use type-based definitions #23421 — same refactor pattern: replace runtime prop objects with exported TypeScript interfaces and switch components to typed defineProps + withDefaults.
refactor(components): [icon] use type-based definitions #23412 — similar change converting runtime prop builders to explicit interfaces and updating .vue prop usage.
refactor(components): [scrollbar] use type-based definitions #23427 — related refactor replacing ExtractPropTypes exports with interfaces and deprecating old aliases.

Suggested reviewers

btea
rzzf

Poem

🐇 I hopped through types and nudged aliases old,
New interfaces stitched, defaults tidy and bold,
Deprecation notes placed with a gentle thump,
Imports slimmed down — one neat little bump,
I left a carrot of clarity on your branch 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description only contains an unchecked contributor checklist and a single issue reference; it lacks substantive explanation of the changes, rationale, and impact of the refactor.	Add a detailed description explaining what was changed (type-based definitions), why this refactor improves the codebase, and any breaking changes or migration notes for users.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main refactor: migrating Steps component definitions from object-based to type-based approach across multiple files.
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:13:35Z

Open in StackBlitz

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

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

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

commit: 41cf65f

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@packages/components/steps/src/item.ts`:
- Around line 6-25: StepProps currently declares description and status as
required but they are given runtime defaults via withDefaults(); update the
interface so both description and status are optional (e.g., description?:
string and status?: '' | 'wait' | 'process' | 'finish' | 'error' | 'success') to
match Vue 3 conventions and the withDefaults() usage; locate the StepProps
interface in item.ts and change the two property signatures accordingly.

github-actions · 2026-01-18T05:19:11Z

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

keeplearning66

Thank you!

github-actions · 2026-01-18T08:11:05Z

@SevenDreamYang Thanks for your contribution! ❤️

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

9a9d972

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

pull-request-triage Bot added the Needs Review label 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

coderabbitai Bot reviewed Jan 18, 2026

View reviewed changes

Comment thread packages/components/steps/src/item.ts

SevenDreamYang and others added 3 commits January 18, 2026 13:20

refactor(components): [steps] use type-based definitions fix Optional

59f02eb

fix: update

51c98ca

fix: remove unnecessary default

e23e107

btea approved these changes Jan 18, 2026

View reviewed changes

keeplearning66 reviewed Jan 18, 2026

View reviewed changes

Comment thread packages/components/steps/src/steps.ts Outdated

Update packages/components/steps/src/steps.ts

0d426f8

keeplearning66 reviewed Jan 18, 2026

View reviewed changes

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

Update packages/components/steps/src/steps.ts

6f6f91f

keeplearning66 reviewed Jan 18, 2026

View reviewed changes

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

Apply suggestion from @keeplearning66

41cf65f

keeplearning66 approved these changes Jan 18, 2026

View reviewed changes

btea approved these changes Jan 18, 2026

View reviewed changes

btea merged commit b2cd7d2 into element-plus:dev Jan 18, 2026
16 of 17 checks passed

element-bot mentioned this pull request Jan 30, 2026

D2M #23568

Merged

3 tasks

Uh oh!

Conversation

SevenDreamYang 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!

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!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

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!

Uh oh!

Uh oh!

Uh oh!

keeplearning66 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Jan 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SevenDreamYang 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