Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Properly deprecate PopoverAlignment type values #16009

Closed
1 task done
Tracked by #14139
tay1orjones opened this issue Mar 19, 2024 · 1 comment · Fixed by #16346
Closed
1 task done
Tracked by #14139

Properly deprecate PopoverAlignment type values #16009

tay1orjones opened this issue Mar 19, 2024 · 1 comment · Fixed by #16346
Assignees
@2nikhiltom
Labels
area: typescript role: dev 🤖 type: bug 🐛

Comments

@tay1orjones
Copy link
Member

tay1orjones commented Mar 19, 2024 •
edited
Loading

In #14654 all Popover-based components were unified to use new values for the align prop.

The old values need to be properly deprecated so we can ensure consumers know to stop using them.

Pull the old values out into their own type, mark it as deprecated via jsdoc
Update PopoverAlignment to be a union of the new values and the new deprecated type
Write a custom validator function for proptypes that pops a warning when a deprecated value is used
Refactor all usages where PopoverAlignment is used to normalize tooltipPosition with tooltipAlignment such as in Button

Tasks
Preview Give feedback
  1. Deprecate PopoverAlignment type values #16326
    3 of 3
    area: typescript role: dev 🤖 type: bug 🐛
    2nikhiltom
@tay1orjones tay1orjones moved this to ⏱ Backlog in Design System Mar 19, 2024
@tay1orjones tay1orjones added this to the 2024 Q1 milestone Mar 19, 2024
@tay1orjones tay1orjones changed the title Properly deprecate PopoverAlignment type Properly deprecate PopoverAlignment type values Mar 19, 2024
@sstrubberg sstrubberg mentioned this issue Mar 20, 2024
Open
@sstrubberg sstrubberg modified the milestones: 2024 Q1, 2024 Q2 Mar 20, 2024
@tay1orjones tay1orjones mentioned this issue Apr 10, 2024
Merged
@2nikhiltom 2nikhiltom moved this from ⏱ Backlog to 🏗 In Progress in Design System May 2, 2024
@tay1orjones tay1orjones added planning: umbrella Umbrella issues, surfaced in Projects views and removed planning: umbrella Umbrella issues, surfaced in Projects views labels May 2, 2024
@2nikhiltom 2nikhiltom mentioned this issue May 8, 2024
Closed
@2nikhiltom 2nikhiltom removed their assignment May 8, 2024
@2nikhiltom 2nikhiltom linked a pull request May 16, 2024 that will close this issue
fix(popover): Deprecate PopoverAlignment type values #16346
Merged
@2nikhiltom
Copy link
Contributor

closed via #16346

@github-project-automation github-project-automation bot moved this from 🏗 In Progress to ✅ Done in Design System May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@2nikhiltom 2nikhiltom

Labels
area: typescript role: dev 🤖 type: bug 🐛
Projects
Design System
Archived in project
Initial TypeScript Support
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(popover): Deprecate PopoverAlignment type values 2nikhiltom/carbon
3 participants
@tay1orjones @sstrubberg @2nikhiltom