refactor(components): [check-tag] use type-based definitions by snowbitx · Pull Request #23424 · element-plus/element-plus

snowbitx · 2026-01-18T02:30: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.

ref #23399

Summary by CodeRabbit

New Features
- CheckTag component now defaults to 'primary' type when not explicitly specified.
Refactor
- Enhanced type safety and prop definitions for CheckTag component, improving consistency and developer experience with better type support.

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

github-actions · 2026-01-18T02:30:25Z

coderabbitai · 2026-01-18T02:30:28Z

📝 Walkthrough

Walkthrough

This PR refactors the check-tag component to introduce a new public CheckTagProps interface and switch from runtime prop definitions to type-based prop interfaces, replacing ExtractPropTypes with ExtractPublicPropTypes for improved type safety.

Changes

Cohort / File(s)	Summary
Type-based Props Refactoring `packages/components/check-tag/src/check-tag.ts`	Introduces new public `CheckTagProps` interface with three optional fields (checked, disabled, type). Replaces `ExtractPropTypes` import with `ExtractPublicPropTypes`. Updates public type alias to `CheckTagPropsPublic` with deprecation notice.
Component Props Definition `packages/components/check-tag/src/check-tag.vue`	Switches from runtime `checkTagProps` usage to type-based `defineProps<CheckTagProps>()` with `withDefaults()`. Sets default value for `type` prop to 'primary'.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

element-plus/element-plus#23412 — Performs the same code-level refactor switching from runtime prop objects to type-based prop interfaces with ExtractPublicPropTypes and withDefaults.
element-plus/element-plus#23400 — Applies the same type-based props refactoring pattern across multiple components.
element-plus/element-plus#23403 — Replaces ExtractPropTypes with explicit public interfaces and ExtractPublicPropTypes, updating components to use type-based defineProps<T>() with withDefaults.

Suggested labels

Contribution::Community

Suggested reviewers

rzzf
keeplearning66

Poem

🐰 A tag that checks, now typed with care,
With props so clear, beyond compare,
From runtime rules to types so bright,
The check-tag hops to syntax's height! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description contains only the repository's standard checklist template and lacks specific details about the changes, implementation, or rationale for the refactoring.	Add a detailed description of what was changed and why (e.g., explain the switch from ExtractPropTypes to ExtractPublicPropTypes, the new CheckTagProps interface, and the benefits of type-based definitions).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main refactoring change: converting the check-tag component to use type-based prop definitions instead of the previous approach.
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-18T02:32:02Z

Open in StackBlitz

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

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

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

commit: 7b3a126

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

packages/components/check-tag/src/check-tag.vue (1)

18-29: Runtime type validation is dropped with the new interface.
The deprecated checkTagProps object previously enforced valid type values via a runtime values validator. Switching to defineProps<CheckTagProps>() uses only the TypeScript interface, which provides compile-time safety but removes the runtime warning for invalid values. Consider reusing the deprecated checkTagProps in defineProps until 3.0.0, or add a custom validator if runtime validation is needed.

🧹 Nitpick comments (1)

packages/components/check-tag/src/check-tag.ts (1)

5-25: Keep CheckTagProps and checkTagProps in sync.
There are now two sources of truth (the interface and the runtime props). Consider deriving the interface from checkTagProps (e.g., ExtractPublicPropTypes) or adding a compile-time assertion so they can’t drift.

github-actions · 2026-01-18T02:37:46Z

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

keeplearning66

Thank you!

github-actions · 2026-01-18T06:28:17Z

@snowbitx Thanks for your contribution! ❤️

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

7b3a126

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

coderabbitai Bot reviewed Jan 18, 2026

View reviewed changes

btea mentioned this pull request Jan 18, 2026

Refactor Component Props to type-based declarations #23399

Closed

64 tasks

keeplearning66 approved these changes Jan 18, 2026

View reviewed changes

btea approved these changes Jan 18, 2026

View reviewed changes

btea merged commit a2d42d8 into element-plus:dev Jan 18, 2026
20 checks passed

element-bot mentioned this pull request Jan 30, 2026

D2M #23568

Merged

3 tasks

coderabbitai Bot mentioned this pull request Feb 22, 2026

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

Merged

coderabbitai Bot mentioned this pull request Apr 17, 2026

feat(components)!: [check-tag] add size prop #24087

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(components): [check-tag] use type-based definitions#23424

refactor(components): [check-tag] use type-based definitions#23424
btea merged 1 commit into
element-plus:devfrom
snowbitx:refactor/use-type-check-tag

snowbitx commented Jan 18, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

github-actions Bot commented Jan 18, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jan 18, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

pkg-pr-new Bot commented Jan 18, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

github-actions Bot commented Jan 18, 2026

Uh oh!

keeplearning66 left a comment

Uh oh!

Uh oh!

github-actions Bot commented Jan 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

snowbitx 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

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

pkg-pr-new Bot commented Jan 18, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jan 18, 2026

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

snowbitx 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