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

[EuiIcon] Remove logic that applies aria-hidden to empty/loading icons; [EuiIconTip] Fix non-i18n'd default aria-label #7606

Merged
merged 3 commits into from
Mar 20, 2024

Conversation

cee-chen
Copy link
Member

@cee-chen cee-chen commented Mar 20, 2024

Summary

closes #7400

Empty and loading icons can still have perfectly valid aria-label attributes that should be made available to screen reader users and not hidden - we should not apply aria-hidden unless there is no meaningful text to read out.

Before After

I also noticed while here that EuiIconTip's default aria-label isn't correctly i18ned, and can be bypassed by consumers passing an empty string, so I tweaked both of those things while here.

QA

To QA EuiIconTip specifically:

Regression testing:

General checklist

  • Browser QA
    • Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA - N/A
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately.
  • Designer checklist - N/A

- primarily affects loading icons - they may still have perfectly valid `aria-label`s that should be accessible to screen readers
@cee-chen cee-chen changed the title [EuiIcon] Remove logic that applies aria-hidden to empty icons [EuiIcon] Remove logic that applies aria-hidden to empty/loading icons Mar 20, 2024
@cee-chen cee-chen changed the title [EuiIcon] Remove logic that applies aria-hidden to empty/loading icons [EuiIcon] Remove logic that applies aria-hidden to empty/loading icons; [EuiIconTip] Fix non-i18n'd default aria-label Mar 20, 2024
@cee-chen cee-chen changed the title [EuiIcon] Remove logic that applies aria-hidden to empty/loading icons; [EuiIconTip] Fix non-i18n'd default aria-label [EuiIcon] Remove logic that applies aria-hidden to empty/loading icons; [EuiIconTip] Fix non-i18n'd default aria-label Mar 20, 2024
@cee-chen cee-chen requested a review from 1Copenut March 20, 2024 19:03
@cee-chen cee-chen marked this pull request as ready for review March 20, 2024 19:03
@cee-chen cee-chen requested a review from a team as a code owner March 20, 2024 19:03
@elasticmachine
Copy link
Collaborator

elasticmachine commented Mar 20, 2024

💚 Build Succeeded

History

@kibanamachine
Copy link

Preview staging links for this PR:

Copy link
Contributor

@1Copenut 1Copenut left a comment

Choose a reason for hiding this comment

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

👍 LGTM! I tested with VO briefly and spot checked icons through the power of Chrome Console $$ selector. Tests were thorough and highlighted override behavior well.

@cee-chen
Copy link
Member Author

Thanks Trevor!

@cee-chen cee-chen merged commit 18dc7ec into elastic:main Mar 20, 2024
8 checks passed
@cee-chen cee-chen deleted the icon/aria-hidden branch March 20, 2024 22:54
cee-chen added a commit to elastic/kibana that referenced this pull request Mar 26, 2024
`v93.4.0` ⏩ `v93.5.1`

---

## [`v93.5.1`](https://github.com/elastic/eui/releases/v93.5.1)

**Bug fixes**

- Fixed unvirtualized `EuiSelectable`s to not cause Jest/jsdom errors on
active option change ([#7618](elastic/eui#7618))

## [`v93.5.0`](https://github.com/elastic/eui/releases/v93.5.0)

- `EuiHeaderLinks` now accepts a `children` render function that will be
passed a `closeMobilePopover` callback, allowing consumers to close the
mobile popover by its content
([#7603](elastic/eui#7603))
- Updated `EuiSelectable` to support scrolling list containers when
`listProps.isVirtualization` is set to `false`
([#7609](elastic/eui#7609))

**Bug fixes**

- Fixed `EuiIconTip`'s default `aria-label` text to be i18n tokenizable
([#7606](elastic/eui#7606))
- Fixed `EuiTextArea`'s CSS box model to no longer render a few extra
pixels of strut height
([#7607](elastic/eui#7607))

**Dependency updates**

- Updated `@types/refractor` to v3.4.0
([#7590](elastic/eui#7590))
- Updated `@types/lodash` to v4.14.202
([#7591](elastic/eui#7591))
- Removed `@types/resize-observer-browser` dependency. `ResizeObserver`
types should already be baked in to Typescript as of 4.2+
([#7592](elastic/eui#7592))
- Updated `classnames` to v2.5.1
([#7593](elastic/eui#7593))
- Updated `@types/numeral` to v2.0.5
([#7594](elastic/eui#7594))
- Updated `@types/react-window` to 1.8.8
([#7597](elastic/eui#7597))
- Updated `prop-types` to v15.18.1
([#7602](elastic/eui#7602))
- Removed `prop-types` as a peer dependency, per package recommendation
([#7602](elastic/eui#7602))

**Accessibility**

- `EuiIcons` no longer apply `aria-hidden` to empty icons, as long as a
valid title or label is provided to the icon. In particular, this is
intended to improve the accessibility of loading `EuiIconTip`s.
([#7606](elastic/eui#7606))
peteharverson added a commit to elastic/kibana that referenced this pull request Apr 2, 2024
## Summary

Unskips the ML accessibility tests skipped in
#17259 following the change made
to `EuiIcon` in elastic/eui#7606 in EUI v93.5.1.

Also fixes a missing aria-label on the tech preview badge on the data
visualizer selector page which would otherwise cause an accessibility
test failure.

🟢 50x flaky test runner:
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/5600


### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [x] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
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.

[EuiIconTip] Ensure aria-hidden attribute is suppressed to avoid axe (accessibility) errors in loading cycle
4 participants