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] Small changes to standardize acessibility section for Data Grid and Tree View #13224

Conversation

arthurbalduini
Copy link
Member

@arthurbalduini arthurbalduini commented May 23, 2024

Some nitpicks I found while working on the acessibility documentation for pickers.

@arthurbalduini arthurbalduini added the docs Improvements or additions to the documentation label May 23, 2024
@arthurbalduini arthurbalduini changed the title [DataGrid][Treeview] Adds complementary info about macOS key replacement [Docs] Adds complementary info about macOS key replacement for DataGrid and Treeview May 23, 2024
Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

Nice improvement 👌


| Keys | Description |
| -----------------------------------------------------------------: | :---------------------------------------------------------- |
| <kbd class="key">Arrow Left</kbd> | Navigate between cell elements |
| <kbd class="key">Arrow Bottom</kbd> | Navigate between cell elements |
| <kbd class="key">Arrow Down</kbd> | Navigate between cell elements |
Copy link
Member

@flaviendelangle flaviendelangle May 23, 2024

Choose a reason for hiding this comment

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

The famous "Arrow Bottom" 😆

@flaviendelangle
Copy link
Member

For the failing CI, rebasing on master should fix it

Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Please sync with latest upstream/master to fix CI. 😉

@@ -31,8 +31,10 @@ The [WAI-ARIA Authoring Practices](https://www.w3.org/WAI/ARIA/apg/patterns/tree
:::info
The following key assignments apply to Windows and Linux users.

On macOS replace <kbd class="key">Ctrl</kbd> with <kbd class="key">⌘ Command</kbd>.

On macOS replace:
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure how correct we are here. 🤔
Those keys definitely exist on MacOS and their keyboards:
https://store.storeimages.cdn-apple.com/4982/as-images.apple.com/is/MQ052?wid=2000&hei=2000&fmt=jpeg&qlt=95&.v=1495129815011
It's only MacBooks with their limited amount of keys or any other keyboard with less keys, which remove less often used keys. 🤔
So, technically, with this we are educating users about MacOS shortcuts for keys that they MIGHT not have on their keyboard.
I'm not saying that we can't do it. Just questioning if maybe we could put a bit less emphasis on it and instead only link to a MacOS keyboard shortcut page? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

Makes total sense for me, I confess I had the idea to add it based on my personal experience with the macbook and didn't consider other MacOS devices.
Maybe we could divide it into 2 info dialogs:

  • for keys that are necessarily different, like command
  • for keys that might be different, like pageUp
    The second one could have a sentence briefly mentioning that some devices might demand the usage of equivalent key combinations, WDYT ?

Anyways, we can split the PR: I will remove those mentions on this PR and let only the small corrections that don't rely on it, while we continue the discussion :)

Copy link
Member

Choose a reason for hiding this comment

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

It makes sense, we can definitely put those additions as improvements that would have less emphasis than actually different buttons. 👍

@mui-bot
Copy link

mui-bot commented May 23, 2024

@arthurbalduini arthurbalduini force-pushed the docs/tree-view-data-grid-a11y-nitpicks branch from 0b16f47 to 62eb110 Compare May 23, 2024 14:40
Copy link
Contributor

@noraleonte noraleonte left a comment

Choose a reason for hiding this comment

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

Very nice catch 🎉

@arthurbalduini arthurbalduini changed the title [Docs] Adds complementary info about macOS key replacement for DataGrid and Treeview [docs] Adds complementary info about macOS key replacement for DataGrid and Treeview May 23, 2024
@arthurbalduini arthurbalduini changed the title [docs] Adds complementary info about macOS key replacement for DataGrid and Treeview [docs] Small changes to standardize acessibility section for Data Grid and Tree View May 23, 2024
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Consider merging latest upstream/master into your branch to avoid unwanted diffs.
Running prettier should fix the CI issues. 😉

@@ -0,0 +1,71 @@
---
productId: x-date-pickers
title: Date and Time Pickers - Date format and localization
Copy link
Member

Choose a reason for hiding this comment

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

Did you intend to add this page on this PR? 🤔
If so, then this title should better reflect the page content and maybe we'd need to adjust the PR title. 😉

Copy link
Member Author

Choose a reason for hiding this comment

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

Looks like I did something wrong 🙈

@arthurbalduini arthurbalduini deleted the docs/tree-view-data-grid-a11y-nitpicks branch May 24, 2024 06:56
@arthurbalduini arthurbalduini restored the docs/tree-view-data-grid-a11y-nitpicks branch May 24, 2024 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants