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

Fix accessibility issues in the docs #10574

Merged
merged 14 commits into from Nov 13, 2023
Merged

Fix accessibility issues in the docs #10574

merged 14 commits into from Nov 13, 2023

Conversation

evanSe
Copy link
Member

@evanSe evanSe commented Nov 9, 2023

Context

We want to improve the accessibility of the Handsontable documentation.

  • Ensure proper keyboard navigation using TAB and Shift+Tab
  • Ensure focus is always visible
  • Address focus issues in all header navigation menus.
  • fix keyboard focus on the light/dark toggle switch.
  • Make collapsed sidebar groups tabbable.

How has this been tested?

  • tested with lighthouse a11y, axe, accessibility insights
  • manually tested

Types of changes

  • New feature or improvement (non-breaking change which adds functionality)

Related issue(s):

Affected project(s):

  • docs

Checklist:

@evanSe evanSe marked this pull request as ready for review November 9, 2023 19:20
Copy link

github-actions bot commented Nov 9, 2023

Launch the local version of documentation by running:

npm run docs:review 5a5e238037fa6785dd9b3ee3d250581a5e2c24a5

budnix
budnix previously approved these changes Nov 10, 2023
Copy link
Member

@budnix budnix left a comment

Choose a reason for hiding this comment

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

Everything looks good 👌 I'll leave a small suggestion about correcting styles for the focus code tabs. Right now it looks like this:
Kapture 2023-11-10 at 09 21 49

and after adding margin
Kapture 2023-11-10 at 09 18 15

diff --git a/docs/.vuepress/theme/styles/vuepress-tabs-custom.styl b/docs/.vuepress/theme/styles/vuepress-tabs-custom.styl
index c8a7d09ae..edf0638d5 100644
--- a/docs/.vuepress/theme/styles/vuepress-tabs-custom.styl
+++ b/docs/.vuepress/theme/styles/vuepress-tabs-custom.styl
@@ -35,6 +35,7 @@
       a.tabs-component-tab-a {
         padding: 0.5em 1.2em;
         color: $textColor;
+        margin: 3px 3px 0px 3px;

         &:hover {
           text-decoration: none;
@@ -68,7 +69,7 @@
       border-radius: 0;
     }
   }
-
+
   &.selected-preview .tabs-component-panels {
     background: transparent;
   }

@evanSe evanSe merged commit fb8585e into develop Nov 13, 2023
29 checks passed
@evanSe evanSe deleted the feature/dev-issue-1434 branch November 13, 2023 13:50
evanSe added a commit that referenced this pull request Nov 14, 2023
* fix(docs): tabIndex and ariaHidden permalink hash

* fix(docs): image alt text in framework dropdown

* fix(docs): focus style in navbar, sidebar, and
table of contents

* fix(docs): allow sidebar headings open keyboard

* fix(docs):  themeswitcher accessibility

* add changelog

* Add enter key press event to toggle theme switcher

* fix height around home link

* fix linting

* fix lint

* pr feedback

* fix: patch package vue-tabs-component invalid aria
@AMBudnik
Copy link
Contributor

AMBudnik commented Dec 1, 2023

Works well in the official version of documentation

Zrzut ekranu 2023-12-1 o 15 11 46

@budnix budnix mentioned this pull request Dec 13, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants