Skip to content

fix(button-base): make aria label change on update after first update lifecycle #5619

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
Closed
wants to merge 2 commits into from
Closed

fix(button-base): make aria label change on update after first update lifecycle #5619

wants to merge 2 commits into from

Conversation

SavkaTaras
Copy link

@SavkaTaras SavkaTaras commented Jul 21, 2025 •
edited by Rajdeepc
Loading

Description

Currently the aria-label attribute gets set on firstUpdate. This causes an issue when the button is rendered and then the prop is updated. The change is not getting reflected. This makes sure the change actually gets reflected.

GitHub bug:

Motivation and context

Adobe Expres bug

Related issue(s)

Screenshots (if appropriate)

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

  • Descriptive Test Statement

    1. Go here
    2. Do this action
    3. Expect this result

  • Descriptive Test Statement

    1. Go here
    2. Do this action
    3. Expect this result

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

@SavkaTaras SavkaTaras requested a review from a team as a code owner July 21, 2025 15:36
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 21, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: a4824c3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Rajdeepc
Rajdeepc requested changes Jul 22, 2025
View reviewed changes
packages/button/src/ButtonBase.ts
Comment on lines +252 to +258
if (changed.has('label')) {
if (this.label) {
this.setAttribute('aria-label', this.label);
} else {
this.removeAttribute('aria-label');
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for doing this. Its a miss edge case from our side. But for better code maintainability can you extract this logic into a private method to avoid duplication. There are three instances of the same code. Second can you please add a test to verify aria-label changes when the label property changes after initial render.

blunteshwar
blunteshwar reviewed Jul 24, 2025
View reviewed changes
Copy link
Contributor

@blunteshwar blunteshwar left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM!
Once we extract the logic in a function and add a changeset for this, I believe we are good to mege!

nikkimk
nikkimk approved these changes Aug 1, 2025
View reviewed changes
Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

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

Looks good to me

@caseyisonit caseyisonit added the a11y Issues related to accessibility label Aug 14, 2025
caseyisonit
caseyisonit requested changes Aug 14, 2025
View reviewed changes
Copy link
Contributor

@caseyisonit caseyisonit left a comment

Choose a reason for hiding this comment

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

@tsavka-adobe Theres a few things that need to be addressed with this PR before we can get it merged in.

  1. We will need you to sign the CLA
  2. There are failing tests that need to be resolved
  3. Automated tests need to be added to cover this new functionality
  4. Manual testing steps need to be added to the PR descriptions particularly since this is a11y based

@tsavka-adobe
Copy link

please close this PR. I think there is another PR for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blunteshwar blunteshwar blunteshwar left review comments

@Rajdeepc Rajdeepc Rajdeepc requested changes

@caseyisonit caseyisonit caseyisonit requested changes

@nikkimk nikkimk nikkimk approved these changes

Assignees
No one assigned
Labels
a11y Issues related to accessibility ready-for-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: button-base aria label not updating on change
6 participants
@SavkaTaras @tsavka-adobe @nikkimk @Rajdeepc @blunteshwar @caseyisonit