carbon-addons-iot-react icon indicating copy to clipboard operation
carbon-addons-iot-react copied to clipboard

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

Open kristy-tabak opened this issue 1 year ago • 1 comments
trafficstars

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

kristy-tabak avatar May 16 '24 04:05 kristy-tabak