mi6 / mi6/ic-ui-kit

Update IcChangeEventDetail interface to have more unique names

Open
#3,834 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

breaking change
Dominant language
TypeScript
Stars
53
Forks
63
Avg merge
2d 4h
Merged PRs (30d)
15

Description

### Summary
We have an IcChangeEventDetail interface in checkbox group, pagination, radio group and toggle button group. When these appear on the types page of the website, it's a guess what they're used for as they're all named the same.

### 💬 Description
We should update the interfaces to have more unique names e.g. IcCheckboxChangeEventDetail. This way they won't appear next to each other on the types page and cause confusion.

Types page at the moment:

Image

We don't have any other types/interfaces with the same name, everything else is more unique.

### 💰 Use value
Avoids confusion with types/interfaces.

### 🚨 Urgency (low, medium or high)
Low - it's a breaking change so will have to be a V4 issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the IcChangeEventDetail interfaces used by the checkbox group, pagination, radio group, and toggle button group, then inspect how their names appear on the website types page. Done means each interface has a distinct component-specific name and all references are updated consistently for the planned V4 breaking change.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.