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

Deprecating EuiKeyboardAccessible #4135

Merged
merged 9 commits into from
Oct 19, 2020

Conversation

myasonik
Copy link
Contributor

@myasonik myasonik commented Oct 14, 2020

Summary

Closes #3838. After this PR is merged, should update the deprecation schedule to include removing EuiKeyboardAccessible and create another issue for addressing EuiBasicTable's a11y issues which are outside the scope of this deprecation.

Adds docs about deprecation

Screenshot of EUI docs for EuiKeyboardAccessible

Fixes EuiCodeEditor

Though EuiCodeEditor didn't use EuiKeyboardAccessible, because it mentioned it in the comments, it came up in this work. It used EuiKeyboardAccessible as a template for how to fix a problem that was better fixed other ways.

Fixes EuiStepsHorizontal

While removing the use of EuiKeyboardAccessible, also took the opportunity to fix up a few other a11y issues with the component, simplify its semantics, and align its string usage across all instances.

Ignores EuiBasicTable

EuiBasicTable uses EuiKeyboardAccessible but unwinding that decision would be a whole can of worms. To deprecate EuiKeyboardAccessible as quickly as possible, pushing off any EuiBasicTable work till a decision on how to deal with it can be reached.

Checklist

  • Check against all themes for compatibility in both light and dark modes
  • Checked in mobile
  • Checked in Chrome, Safari, Edge, and Firefox
  • Props have proper autodocs
  • Added documentation
  • Checked Code Sandbox works for the any docs 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

@myasonik myasonik added accessibility deprecations Contains deprecations. Add them to the deprecations meta ticket after merge. labels Oct 14, 2020
@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

@myasonik myasonik force-pushed the deprecate-EuiKeyboardAccessible branch from c0c515f to f7cdaf4 Compare October 15, 2020 15:04
@myasonik myasonik force-pushed the deprecate-EuiKeyboardAccessible branch from f7cdaf4 to eed5d59 Compare October 15, 2020 15:05
@myasonik myasonik marked this pull request as ready for review October 15, 2020 15:05
@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
src/components/steps/step_number.tsx Outdated Show resolved Hide resolved
src/components/steps/step_horizontal.tsx Outdated Show resolved Hide resolved
src/components/steps/step_horizontal.tsx Outdated Show resolved Hide resolved
@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

@myasonik myasonik requested review from cchaos and thompsongl October 15, 2020 21:24
Copy link
Contributor

@thompsongl thompsongl left a comment

Choose a reason for hiding this comment

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

Couple small things
+1 to finding a way around the li click event pass-through

src/components/steps/step_strings.tsx Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@myasonik myasonik requested a review from thompsongl October 16, 2020 22:00
@cchaos
Copy link
Contributor

cchaos commented Oct 19, 2020

One thing real quick is that CI is throwing this error because you probably forgot to change a token key when copy/pasting.

18:26:55 Token euiStepStrings.warning has two differing defaults:
18:26:55 Step {number} has warnings
18:26:55 Step {number}: {title} has warnings

Copy link
Contributor

@cchaos cchaos left a comment

Choose a reason for hiding this comment

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

The EuiStep rendering issues all seem to be fixed and display as they did before. 👍 CI is having some issues though, so be sure to fix those.

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@thompsongl thompsongl left a comment

Choose a reason for hiding this comment

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

Looks good to merge after these changes

src/components/steps/step_strings.tsx Outdated Show resolved Hide resolved
src/components/steps/step_strings.tsx Outdated Show resolved Hide resolved
src/components/steps/step_strings.tsx Outdated Show resolved Hide resolved
Co-authored-by: Caroline Horn <549577+cchaos@users.noreply.github.com>
Co-authored-by: Greg Thompson <thompson.glowe@gmail.com>
@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Caroline Horn <549577+cchaos@users.noreply.github.com>
@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4135/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility deprecations Contains deprecations. Add them to the deprecations meta ticket after merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[EuiKeyboardAccessible] Discuss deprecation
4 participants