Back

Code quality

Design System Component Cleanup: Retire Deprecated UI Patterns Safely

Design system component cleanup begins when deprecated components, props, variants, and examples remain published after product teams have moved to a new pattern.

The useful output is a component retirement pull request with import evidence, migration path, visual checks, release note, and final export change. Keep the review concrete: Deprecate exports before removing source when downstream packages update slowly, then make the next action visible to the team that owns the risk. That matters because the cleanup can still go wrong when breaking product screens or downstream packages still using old components.

Key takeaways

  • Treat each cleanup candidate as an owned system with dependencies, not anonymous clutter.
  • Use one design system release cycle plus the longest downstream package support window before deciding that “quiet” means “unused.”
  • Prefer reversible changes first when breaking product screens or downstream packages still using old components is still plausible.
  • Leave behind a component retirement pull request with import evidence, migration path, visual checks, release note, and final export change so the next review starts with context.
  • Measure the result as lower spend, lower risk, less operational drag, or clearer ownership.

Map Component Consumers

Start with one component family across package exports, product imports, docs, Storybook stories, codemods, visual tests, and release notes. The best cleanup scope is small enough that owners can answer quickly but wide enough to include the attachments that make removal risky.

FieldWhy it matters
OwnerCleanup needs a person or team that can accept the decision
Current purposeA short reason to keep the item, written in present tense
Last meaningful useowners, callers, last change, runtime behavior, and deletion confidence
Dependency evidencerepository search, tests, logs, deploy history, and owner review
Risk if wrongThe outage, data loss, access failure, or rollback gap the review must avoid
Next actionKeep, reduce, archive, disable, remove, or investigate

Do not make the inventory larger than the decision. A short list with owners and evidence beats a perfect spreadsheet that nobody is willing to act on.

Component Evidence to Collect

The useful question is not “how old is it?” It is “what would break, become harder to recover, or lose accountability if this disappeared?” For design system component cleanup, collect enough evidence to answer that without relying on naming conventions.

CheckWhat to look forCleanup signal
Import surfacePackage exports, product imports, examples, Storybook stories, and generated docsNo supported consumer imports the deprecated component
Replacement parityNew component, prop mapping, accessibility behavior, tokens, and migration examplesConsumers have a clear path
Release contractPackage version policy, deprecation notice, changelog, and downstream package pinsRemoval will not surprise supported versions
Visual riskScreenshots, visual tests, theme variants, and responsive statesThe replacement preserves important UI behavior

Use several signals together. Activity can miss monthly jobs and incident-only paths. Ownership can be stale. Cost can distract from security or recovery risk. The strongest case combines runtime data, dependency checks, owner review, and a rollback plan.

If the evidence conflicts, label the item “investigate” with a named owner and review date. That is still progress because the next review starts with a narrower question.

Example Evidence Check

Search imports, docs, and published examples before removing a deprecated component export.

rg "DeprecatedButton|LegacyModal|OldSelect" apps packages docs storybook
rg "from ['\"]@company/design-system|@company/ui" apps packages examples
rg "deprecated|replacement|migration" packages/design-system docs storybook

Treat the output as a candidate list. Do not pipe these checks into delete commands; add owner review, dependency checks, and a rollback path first.

Deprecate Before Removing

Use the least permanent move that proves the decision. In design system component cleanup, removal is only one possible outcome; reducing size, narrowing permission, shortening retention, archiving, or disabling a trigger may produce the same benefit with less risk.

  • Deprecate exports before removing source when downstream packages update slowly.
  • Ship codemods or examples for common prop migrations.
  • Delete docs, stories, tests, and tokens with the component once imports are gone.

Track the cleanup candidate with a simple priority score:

ScoreGood signBad sign
ImpactMeaningful spend, risk, toil, noise, or confusion disappearsThe item is cheap and low-risk but politically distracting
ConfidenceOwner, purpose, and dependency path are understoodThe team is guessing from age or name
ReversibilityRestore, recreate, re-enable, or rollback path existsDeletion would be the first real test
PreventionA rule can stop recurrenceThe same pattern will return next month

Start with high-impact, high-confidence, reversible candidates. Defer confusing items only if they get an owner and a date; otherwise “defer” becomes another word for keeping waste permanently.

UI Contracts Downstream Apps Use

Some cleanup candidates are supposed to look quiet. Do not rush these cases:

  • Published packages, white-label themes, accessibility-sensitive controls, and embedded admin tools.
  • Components used by downstream teams outside the monorepo.
  • Deprecated variants that still encode product-specific behavior.

For these cases, use a longer observation window, explicit owner approval, and a staged reduction. The point is not to avoid cleanup; it is to avoid making the first proof of dependency an outage.

Run the Component Retirement

Run design system component cleanup as a decision review, not an open-ended hygiene project.

  1. Pick the narrow scope and export the candidate list.
  2. Add owner, current purpose, last-use evidence, dependency checks, and risk if wrong.
  3. Remove obvious false positives, then ask owners to choose keep, reduce, archive, disable, remove, or investigate.
  4. Apply the least permanent useful change first.
  5. Watch the signals that would reveal a bad decision.
  6. Complete the final removal only after the review window closes.
  7. Save a component retirement pull request with import evidence, migration path, visual checks, release note, and final export change.

For broader cleanup planning, use the cleanup library to pair this guide with related notes. If the cleanup has infrastructure impact, pair it with a visible owner, a rollback path, and a measurable business case. For infrastructure cleanup, the main cloud cost optimization checklist is a useful companion.

Make Deprecation Measurable

Prevention should change the creation path, not just the cleanup path. For design system component cleanup, the useful prevention fields are owner, reason to exist, removal trigger, and verification notes. Make those fields part of normal creation and review.

  • Create components with owner, replacement policy, stability status, and removal criteria.
  • Track deprecated imports in CI or package telemetry.
  • Review component cleanup during major design system releases.

The recurring review should be short: sort by impact, pick the unclear items, assign owners, and close the loop on anything nobody claims. If the review keeps producing the same class of candidate, fix the creation path instead of celebrating repeated cleanup.

Example Decision Record

Use a compact record so the cleanup can be reviewed later without reconstructing the whole investigation.

FieldExample entry for this cleanup
CandidateDeprecated design system components in frontend design systems
Why it looked staleLow recent activity, unclear owner, or no current consumer after the first review
Evidence checkedImport surface, Replacement parity, and owner confirmation
First reversible moveDeprecate exports before removing source when downstream packages update slowly
Watch signalThe metric, alert, job, route, query, or owner complaint that would show the cleanup was wrong
Final actionKeep, reduce, archive, disable, or remove after one design system release cycle plus the longest downstream package support window
Prevention ruleCreate components with owner, replacement policy, stability status, and removal criteria

This record is intentionally small. If the decision needs a long narrative, the candidate is probably not ready for removal yet. Keep investigating until the owner, evidence, reversible move, and prevention rule are clear.

FAQ

How often should teams do design system component cleanup?

Use one design system release cycle plus the longest downstream package support window for the first decision, then set a recurring cadence based on change rate. Fast-moving non-production systems may need monthly review; slower systems can be quarterly if every unclear item has an owner and a review date.

What is the safest first action?

The safest first action is usually ownership repair plus evidence collection. After that, deprecate exports before removing source when downstream packages update slowly. That creates a visible test before permanent deletion.

What should not be removed quickly?

Do not rush anything connected to published packages, white-label themes, accessibility-sensitive controls, and embedded admin tools. Also slow down when the cleanup affects recovery, compliance, customer-specific behavior, rare schedules, or security response.

How do you make the decision useful later?

Write the decision as a small operational record: candidate, owner, evidence, chosen action, watch signals, rollback path, final date, and prevention rule. That format helps future engineers, search engines, and AI assistants understand the cleanup without guessing.