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

[DOCS] Added a11y guidance for EuiTooltip and EuiPopover #7527

Merged
merged 1 commit into from
Feb 14, 2024
Merged

[DOCS] Added a11y guidance for EuiTooltip and EuiPopover #7527

merged 1 commit into from
Feb 14, 2024

Conversation

1Copenut
Copy link
Contributor

@1Copenut 1Copenut commented Feb 13, 2024

Summary

Updated documentation for a11y considerations in the EuiTooltip and EuiPopover components. Screenshots attached at the bottom.

QA

Remove or strikethrough items that do not apply to your PR.

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
  • Docs site QA

Screenshot 2024-02-13 at 3 22 08 PM
Screenshot 2024-02-13 at 3 21 42 PM

* Added a11y guidance to EuiTooltip.
* Added a11y guidance to EuiPopover.
@1Copenut 1Copenut added documentation Issues or PRs that only affect documentation - will not need changelog entries accessibility skip-changelog labels Feb 13, 2024
@1Copenut 1Copenut self-assigned this Feb 13, 2024
@1Copenut 1Copenut requested a review from a team as a code owner February 13, 2024 21:33
@1Copenut 1Copenut changed the title [DOCS] Added guidance for EuiTooltip, EuiPopover [DOCS] Added guidance for EuiTooltip and EuiPopover Feb 13, 2024
@1Copenut 1Copenut changed the title [DOCS] Added guidance for EuiTooltip and EuiPopover [DOCS] Added a11y guidance for EuiTooltip and EuiPopover Feb 13, 2024
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @1Copenut

Copy link
Member

@JasonStoltz JasonStoltz left a comment

Choose a reason for hiding this comment

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

This advice looks spot on to me. Thanks Trevor.

@1Copenut 1Copenut merged commit 6468ebd into elastic:main Feb 14, 2024
11 of 12 checks passed
@1Copenut 1Copenut deleted the docs/tooltips-popovers-guidance branch February 14, 2024 16:25

<EuiCallOut
iconType="accessibility"
color="warning"
Copy link
Contributor

@cee-chen cee-chen Feb 14, 2024

Choose a reason for hiding this comment

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

I really like how you moved the popover intro up here!

One note: We've historically used the blue/informational color for accessibility callouts in the past (example here). I'm not sure how we want to strike the balance of friendliness vs importance, but I think we should consider noting all our callouts around accessibility and ensuring we have some sort of consistent pattern in place and documented for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wondered about that, and I'm glad you brought it up @cee-chen. I'm happy to take another swing at this to modify the a11y callouts to blue and use that as a general guideline for future callouts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants