refactor(components): [timelineItem] use type-based definitions by cjn021 · Pull Request #23479 · element-plus/element-plus

cjn021 · 2026-01-19T14:24:40Z

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.

Summary by CodeRabbit

Refactor
- Improved Timeline item prop handling with stronger typing and introduced default values for key properties — timestamp (empty), placement (bottom), type (empty), color (empty) and size (normal).

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

github-actions · 2026-01-19T14:24:49Z

coderabbitai · 2026-01-19T14:24:56Z

Warning

Rate limit exceeded

@rzzf has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 39b6e21 and 6fd541a.

📒 Files selected for processing (1)

packages/components/timeline/src/timeline-item.ts

📝 Walkthrough

Walkthrough

Replaces the TimelineItem component's runtime prop-object export with an explicit exported TimelineItemProps interface, deprecates the old prop-object/type export, introduces a TimelineItemPropsPublic alias, and updates the Vue component to use typed defineProps<TimelineItemProps>() with defaults.

Changes

Cohort / File(s)	Summary
TimelineItem Type Definition `packages/components/timeline/src/timeline-item.ts`	Adds exported `TimelineItemProps` interface (timestamp, hideTimestamp, center, placement, type, color, size, icon, hollow); replaces `ExtractPropTypes` import with `Component, ExtractPublicPropTypes`; marks new interface and existing `timelineItemProps` as deprecated; removes `export type TimelineItemProps = ExtractPropTypes<...>`; adds `export type TimelineItemPropsPublic = ExtractPublicPropTypes<typeof timelineItemProps>`.
TimelineItem Component `packages/components/timeline/src/timeline-item.vue`	Switches from importing `timelineItemProps` to `import type { TimelineItemProps }`; uses `defineProps<TimelineItemProps>()` with `withDefaults` to set defaults for `timestamp`, `placement`, `type`, `color`, and `size`; removes runtime prop-object import.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

refactor(components): [countdown] use type-countdown definitions #23447: Applies the same refactor pattern—introduces explicit Props interface, deprecates ExtractPropTypes-based export, adds ExtractPublicPropTypes alias, and updates .vue to use typed defineProps with withDefaults.
refactor(components): [text] use type-based definitions #23481: Same prop-type refactor across components—switches to exported interfaces and public alias, deprecates old exports, and updates component defineProps usage.
refactor(components): [calendar] use type-based definitions #23419: Related refactor replacing ExtractPropTypes-based exports with interfaces and updating component files to use typed defineProps with defaults.

Suggested reviewers

Dsaquel
btea

Poem

🐰✨ I nibbled through props, neat and spry,
Interfaces planted under the sky,
Defaults like carrots placed just so,
Old types bow out, new types grow,
Hoppity cheers for tidy code! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description contains only the template checklist with no actual content describing the changes, issues addressed, or rationale for the refactoring.	Add a description explaining what was refactored, why, and any breaking changes or migration notes. Reference any related issues using GitHub issue syntax (`#number`).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: refactoring timelineItem component to use type-based definitions instead of prop builders.
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-19T14:26:23Z

Open in StackBlitz

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

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

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

commit: 6fd541a

github-actions · 2026-01-19T14:32:16Z

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

github-actions · 2026-01-20T00:12:36Z

@Lensiq Thanks for your contribution! ❤️

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

745b054

pull-request-triage Bot assigned cjn021 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

rzzf approved these changes Jan 19, 2026

View reviewed changes

Comment thread packages/components/timeline/src/timeline-item.vue

rzzf added 2 commits January 20, 2026 01:13

Update packages/components/timeline/src/timeline-item.vue

39b6e21

fix: type error

6fd541a

btea approved these changes Jan 20, 2026

View reviewed changes

btea merged commit 20bc3bc into element-plus:dev Jan 20, 2026
16 checks passed

This was referenced Jan 20, 2026

refactor(components): [form/form-item] use type-based definitions #23483

Merged

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

Merged

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

Merged

element-bot mentioned this pull request Jan 30, 2026

D2M #23568

Merged

3 tasks

coderabbitai Bot mentioned this pull request Feb 9, 2026

docs(components): [timeline] fix color prop type #23642

Merged

3 tasks

coderabbitai Bot mentioned this pull request Mar 16, 2026

refactor(components): [segmented] make component generic #23678

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(components): [timelineItem] use type-based definitions#23479

refactor(components): [timelineItem] use type-based definitions#23479
btea merged 3 commits into
element-plus:devfrom
cjn021:refactor/timelineitem-type-based

cjn021 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

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

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

edited

Loading

Uh oh!

github-actions Bot commented Jan 19, 2026 •

edited

Loading

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

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

Rate limit exceeded

Walkthrough

Changes

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!

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!

github-actions Bot commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cjn021 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