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

Fix: Add soft deperecation notice for the ButtonGroup component #65429

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Fix: Add soft deperecation notice for the ButtonGroup component #65429

merged 5 commits into from
Dec 17, 2024

Conversation

hbhalodia
Copy link
Contributor

@hbhalodia hbhalodia commented Sep 18, 2024 •
edited by mirka
Loading

What?

Issue - #65338

Why?

How?

  • PR add the @deprecate on JS Doc.
  • PR updates the README and story book to feature as deprecated.

Testing Instructions

  1. Use ButtonGroup component, it should show the warning in console with deprecation message.

Testing Instructions for Keyboard

  • NIL

Screenshots or screencast

Screenshot 2024-09-18 at 10 35 19 AM

✍️ Dev Note

The ButtonGroup component has been deprecated, as it can easily lead to accessibility issues. For simpler adherence to accessibility best practices and to be consistent with the current WordPress design system, use ToggleGroupControl instead.

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 18, 2024 •
edited
Loading

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: hbhalodia <[email protected]>
Co-authored-by: mirka <[email protected]>
Co-authored-by: ciampo <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@hbhalodia hbhalodia mentioned this pull request Sep 18, 2024
Closed
2 tasks
@ciampo ciampo added the [Status] Blocked Used to indicate that a current effort isn't able to move forward label Sep 18, 2024
@ciampo
Copy link
Contributor

ciampo commented Sep 18, 2024

Let's wait before reviewing / merging this one until all usages of ButtonGroup have been removed in the repo.

@mirka mirka added [Type] Code Quality Issues or PRs that relate to code quality [Package] Components /packages/components and removed [Status] Blocked Used to indicate that a current effort isn't able to move forward labels Dec 13, 2024
mirka
mirka reviewed Dec 13, 2024
View reviewed changes
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're finally ready to proceed with this one!

Please also add a changelog 🙏

packages/components/src/button-group/README.md Outdated Show resolved Hide resolved
packages/components/src/button-group/stories/index.story.tsx Show resolved Hide resolved
packages/components/src/button-group/index.tsx Outdated Show resolved Hide resolved
packages/components/src/button-group/index.tsx Outdated Show resolved Hide resolved
packages/components/src/button-group/index.tsx Outdated Show resolved Hide resolved
@ciampo ciampo mentioned this pull request Dec 13, 2024
Closed
4 tasks
@hbhalodia hbhalodia requested a review from mirka December 16, 2024 05:16
@hbhalodia
Copy link
Contributor Author

Hi @mirka, All the feedbacks have been addressed in the PR and also added the changelog for the soft deprecation. Let me know if we need to change wordings for deprecation message?

Thank You,

@mirka mirka added the has dev note when dev note is done (for upcoming WordPress release) label Dec 17, 2024
mirka
mirka approved these changes Dec 17, 2024
View reviewed changes
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thank you!

@mirka mirka merged commit 028f72d into WordPress:trunk Dec 17, 2024
66 checks passed
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 17, 2024
yogeshbhutkar pushed a commit to yogeshbhutkar/gutenberg that referenced this pull request Dec 18, 2024
@hbhalodia @mirka
@ciampo @yogeshbhutkar
Fix: Add soft deperecation notice for the ButtonGroup component (Word…
5325a78 
…Press#65429)

* Add deperecation notice for the ButtonGroup component

* Address the feedbacks for deprecation for ButtonGroupControl

* Add the changelog deprecation message.

* Update the changelog comment

Co-authored-by: hbhalodia <[email protected]>
Co-authored-by: mirka <[email protected]>
Co-authored-by: ciampo <[email protected]>
yogeshbhutkar pushed a commit to yogeshbhutkar/gutenberg that referenced this pull request Dec 18, 2024
@hbhalodia @mirka
@ciampo @yogeshbhutkar
Fix: Add soft deperecation notice for the ButtonGroup component (Word…
272aff5 
…Press#65429)

* Add deperecation notice for the ButtonGroup component

* Address the feedbacks for deprecation for ButtonGroupControl

* Add the changelog deprecation message.

* Update the changelog comment

Co-authored-by: hbhalodia <[email protected]>
Co-authored-by: mirka <[email protected]>
Co-authored-by: ciampo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mirka mirka mirka approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

Assignees

@hbhalodia hbhalodia

Labels
has dev note when dev note is done (for upcoming WordPress release) [Package] Components /packages/components [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Milestone
Gutenberg 20.0
Development

Successfully merging this pull request may close these issues.
3 participants
@hbhalodia @ciampo @mirka