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.

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

fix(suiteheader): added the type attribute to the btn #3864

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

kristy-tabak
Copy link
Collaborator

Closes #
[Accessiblity] Issue in the component from outdated library #62074

Summary

Licensing Development Project consuming SuiteHeader component from carbon-addons-iot-react library, "SuiteHeader" component has accessibility issue related to the requirement: "Provide accessibility properties".

The type attribute is specifying the context of usage and it is a good practice to always declare the type of a button explicitly.

Change List (commits, features, bugs, etc)

  • The correct type attribute has been added explicitly to improve accessibility.

Acceptance Test (how to verify the PR)

  • Scan from IBM Equal Access Accessibility Checker and screen reader not found the issue.

Regression Test (how to make sure this PR doesn't break old functionality)

  • no break changes, the type="button" attribute of HTML indicates that the button has no default behaviour, it doesn't directly impact the app logic or behaviour of the element.

Things to look for during review

  • Make sure all references to iot or bx class prefix is using the prefix variable
  • (React) All major areas have a data-testid attribute. New test ids should have test written to ensure they are not changed or removed.
  • UI should be checked in RTL mode to ensure the proper handling of layout and text.
  • All strings should be translatable.
  • The code should pass a11y scans (The storybook a11y knob should show no violations). New components should have a11y test written.
  • Unit test should be written and should have a coverage of 90% or higher in all areas.
  • All components should be passing visual regression test. For new styles or components either a visual regression test should be written for all permutations or the base image updated.
  • Changes or new components should either write new or update existing documentation.
  • PR should link and close out an existing issue

Copy link

netlify bot commented May 16, 2024

Deploy Preview for carbon-addons-iot-react ready!

Name Link
🔨 Latest commit a912308
🔍 Latest deploy log https://app.netlify.com/sites/carbon-addons-iot-react/deploys/66458ceab9bfd00008eb6a1e
😎 Deploy Preview https://deploy-preview-3864--carbon-addons-iot-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant