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

Document component keyboard shortcuts (a11y) #292

Merged

Conversation

benzara-tahar
Copy link
Contributor

@benzara-tahar benzara-tahar commented Sep 27, 2022

This PR tracks the progress of adding the documentation for all the components keyboard shortctus, it is still a WIP

components

  • ListBox
  • Accordions
  • Avatars (no keyboard interactions)
  • Alerts (no keyboard interactions)
  • Breadcrumbs (no keyboard interactions)
  • Conic Gradient (no keyboard interactions)
  • Data Tables
  • Menu (no keyboard interactions in new version)
  • Progress Bar (no keyboard interactions)
  • Progress Radial (no keyboard interactions)
  • Radio Groups
  • Range Slider
  • Slide Toggle
  • Stepper (no keyboard interactions)
  • Tabs
  • Tooltips (leave this to endigo)

utilities

  • Drawers
  • Dialogs (leave this to endigo)
  • Toasts (leave this to endigo)
  • Lightswitch

@endigo9740
Copy link
Contributor

@benzara-tahar Gosh it's always a pleasure to work with someone organized! You've got a checklist here and everything. Love it!

Looking over the PR, everything looks great. Just a few very small nit-picky to set convention going forward:

  • The section heading can be "Keyboard Shortcuts" or "Keyboard Interactions" (Mantine uses the latter), but either way capitalize both words please.
  • The first table column could probably be renamed from "Keyboard Shortcut" to "Key" or "Keys"
  • Components will act as a single unit, even parent/child pairs, so you can rename the table constant from tableA11yKeyboardList to just tableKeys. That'll be easier to recall from memory!

Beyond that I think you nailed it. The descriptions are clear and read well.

I mentioned this in Discord, but it appears we've had a regression of features for the Listbox component. I'm almost certain we had home/end if not up/down arrows support at some point. This component recently went through a refactor so it seems we missed this. I think your update are going to help highlight issues like this, so thank you so much!

@endigo9740
Copy link
Contributor

endigo9740 commented Sep 28, 2022

Looking good with the addition of the data table and accordion. Good catch on the lastIndex fix for the table. FYI this is one of several features being reworked in the near future:

Given there's a lot changes coming to these, it may be better to let me rework the docs so the changes are all self-contained. For example, I'm working on the Menu now and the changes are pretty substantial. We're moving from a Svelte Component to Tailwind Elements + Svelte Action:

Just want to ensure you're not putting in effort on something that's going to be thrown out and rebuilt soon! Plus this might make the merge a but funky. I don't plan to update the data table before your changes go into effect, so those should be fine as is, but Menus and other other should probably be skipped for now!

@benzara-tahar
Copy link
Contributor Author

I love the new actions API, will read more about that but I think you make a point, it is more efficient/reasonable if you document the shaking parts.

@endigo9740
Copy link
Contributor

Thanks, still plenty to figure out but the concept is solid. Yeah no worries, I'll handle the docs listed in that link above. Feel free to prune those from your todo list or move them to their own category for now. Whatever works!

@endigo9740 endigo9740 mentioned this pull request Sep 28, 2022
@endigo9740
Copy link
Contributor

FYI I've applied a11y info and keyboard interactions to the upcoming Menu update. Note that Tooltip are still marked "work in progress" for the ARIA guidelines, so I may revisit that in the future.

Screen Shot 2022-09-29 at 2 57 06 PM

@endigo9740 endigo9740 linked an issue Sep 30, 2022 that may be closed by this pull request
@endigo9740
Copy link
Contributor

@benzara-tahar Per my post in Discord I'll be away this weekend for my birthday. If you need anything before Monday please reach out to a moderator on Discord. Have a nice one and catch you next week!

@benzara-tahar
Copy link
Contributor Author

I went through all the items in the checklist that aren't marked with (leave this to endigo), had to do a small fix for the SlideToggle interaction inorder to make it work.
Also Happy birthday btw @endigo9740 :)

@endigo9740
Copy link
Contributor

Great job @benzara-tahar I'm just getting caught up with everything over the weekend, but will review this asap. FYI make sure to tap "ready for review" to make a formal declaration when you're ready for me to take a look! I'll grab for it now.

@endigo9740 endigo9740 marked this pull request as ready for review October 3, 2022 16:01
@endigo9740
Copy link
Contributor

@benzara-tahar I've completely my review. There was a few bit of text that I adjusted, but nothing major. I think with this we're good to merge. Great job with this, very clearly done! You should appear as a contributor on GitHub and our homepage very soon :)

@endigo9740 endigo9740 merged commit 9e8a161 into skeletonlabs:dev Oct 3, 2022
@endigo9740 endigo9740 changed the title WIP: Document component keyboard shortcuts (a11y) Document component keyboard shortcuts (a11y) Oct 3, 2022
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.

Document component keyboard shortcuts (a11y)
2 participants