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

EuiNavDrawer focus management, flyout auto-close #2749

Merged
merged 14 commits into from
Jan 10, 2020

Conversation

thompsongl
Copy link
Contributor

@thompsongl thompsongl commented Jan 9, 2020

Summary

  1. Closes EuiNavDrawerFlyout when a list item inside is clicked (ref: Grouped Kibana nav kibana#53545 (comment))
  2. Enables a focus trap inside of EuiNavDrawerFlyout upon opening. This allows for tab order to immediately move to the subnav list items. ESC will close the flyout and return focus to the main list. (ref: Nav drawer a11y problems #2252)

Note that both solutions take less-than-ideal implementations. As is, the composition of EuiNavDrawer (by way of EuiListGroup) does not allow for nested list elements, and sub-lists do not exist in the DOM until explicit 'open' action(s) occur. This means that normal React ref behavior and ideal aria-* DOM attributes can't be used. The refactor to allow for both would be more akin to a full rewrite of several components, which, given the 7.6 FF date, we can't really approach.

Checklist

- [ ] Check against all themes for compatibility in both light and dark modes
- [ ] Checked in mobile

  • Checked in IE11 and Firefox

- [ ] Props have proper autodocs
- [ ] Added documentation examples
- [ ] Added or updated jest tests
- [ ] Checked for breaking changes and labeled appropriately

  • Checked for accessibility including keyboard-only and screenreader modes
  • A changelog entry exists and is marked appropriately

this.closeFullScreen();
// event.preventDefault();
// event.stopPropagation();
// this.closeFullScreen();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will revert this or make this not collide with new ESC behavior

@ryankeairns
Copy link
Contributor

The refactor to allow for both would be more akin to a full rewrite of several components, which, given the 7.6 FF date, we can't really approach.

Adding to that point, it seems likely we will rewrite the nav drawer for K8.

Copy link
Contributor

@snide snide left a comment

Choose a reason for hiding this comment

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

Functionality seems good for mouse / keyboard / trapping.

I'd suggest maybe doing a pass on the aria labels you have for the example. I can give you a gist of the groupings I had, which might make more sense, but i think we probably want labels on the top level menu items to describe themselves a such. As a basic example.

If no sub menu

"Go to SIEM app"

If does have sub menu

"List 4 Analytics apps"

I'm sure @myasonik can provide some better direction here. Likely it's something we just need to add to the examples, and not touch in the components themselves.

@myasonik
Copy link
Contributor

myasonik commented Jan 9, 2020

For regular links, let's not touch them. They're a regular element that users will be familiar with and their assistive tech will expose.

For buttons that open a sub-menu, let's add aria-expanded="true|false" to them which should give screen reader users the hint that something's going to happen and we shouldn't have to rely on custom strings.

Going through the example, the focus trap right now isn't announced to screen readers at all. If we can, could we actually get rid of the focus trap? After tabbing from the last item, return focus to the button that opened it and close the sub-menu. (If that's not feasible in the time span we have left, we can steal some modal semantics from flyouts, I think. It won't be very pretty but it should work.)

And, to sneak in one more nice-to-have, could we add the heading of the sub-menus as an aria-labelledby={idOfTheHeading} to the ul that follows it?

@snide
Copy link
Contributor

snide commented Jan 9, 2020

Going through the example, the focus trap right now isn't announced to screen readers at all. If we can, could we actually get rid of the focus trap? After tabbing from the last item, return focus to the button that opened it and close the sub-menu. (If that's not feasible in the time span we have left, we can steal some modal semantics from flyouts, I think. It won't be very pretty but it should work.)

A role="dialog" would likely fix this fairly easily, and makes the most sense I think? It would act like a popover.

@thompsongl
Copy link
Contributor Author

A role="dialog" would likely fix this fairly easily, and makes the most sense I think? It would act like a popover.

I'm going to do my due diligence on tracking tab inside the flyout, but I think the likely solution will be adding dialog/role semantics, yes.

@myasonik myasonik mentioned this pull request Jan 10, 2020
11 tasks
@thompsongl
Copy link
Contributor Author

@snide This is ready for another look.

  • I was able to get tab-through behavior to work
  • I left in esc to close behavior
  • I removed dialog semantics based on recommendation from @myasonik given the above items

Copy link
Contributor

@snide snide left a comment

Choose a reason for hiding this comment

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

LGTM on merge of thompsongl#10

We noticed a small focus issue that @thompsongl is working through.

@thompsongl
Copy link
Contributor Author

We noticed a small focus issue that @thompsongl is working through.

Fixed. Ready for you @myasonik

Copy link
Contributor

@myasonik myasonik left a comment

Choose a reason for hiding this comment

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

Looks great!

I spent some time trying to break the focus order and couldn't so it seems good to merge!

@snide snide mentioned this pull request Jan 10, 2020
7 tasks
@thompsongl thompsongl merged commit c0dc52d into elastic:master Jan 10, 2020
@thompsongl thompsongl mentioned this pull request Jan 10, 2020
6 tasks
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.

4 participants