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

Components: Add Menu #29645

Closed
wants to merge 8 commits into from
Closed

Components: Add Menu #29645

wants to merge 8 commits into from

Conversation

sarayourfriend
Copy link
Contributor

@sarayourfriend sarayourfriend commented Mar 8, 2021

Description

Adds a new Menu component. We do not write an adapter for MenuItem because the new MenuItem is only meant to be used inside of this Menu component which did not previously exist. Rather than using an adapter to use the new MenuItem, consumers should update to just use the Menu component directly with its corresponding Header and Item components.

Depends on #29592

How has this been tested?

Run storybook (npm run storybook:dev), go to the experimental components Menu and test that the menu item is selectable and appears correctly. Also test with keyboard navigation to try to focus the menu item and select it using the keyboard (Space or Enter)

Screenshots

Example of the Menu item

Types of changes

New feature

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@sarayourfriend sarayourfriend added [Package] Components /packages/components Needs Accessibility Feedback Need input from accessibility Storybook Storybook and its stories for components [Feature] Component System WordPress component system labels Mar 8, 2021
@sarayourfriend sarayourfriend self-assigned this Mar 8, 2021
@github-actions
Copy link

github-actions bot commented Mar 8, 2021

Size Change: +2.54 kB (0%)

Total Size: 1.4 MB

Filename Size Change
build/api-fetch/index.js 3.4 kB +1 B (0%)
build/block-directory/index.js 8.63 kB +1 B (0%)
build/block-editor/index.js 126 kB +1.22 kB (+1%)
build/block-editor/style-rtl.css 12.4 kB +65 B (+1%)
build/block-editor/style.css 12.4 kB +68 B (+1%)
build/block-library/blocks/cover/editor-rtl.css 605 B +6 B (+1%)
build/block-library/blocks/cover/editor.css 605 B +6 B (+1%)
build/block-library/blocks/freeform/editor-rtl.css 2.46 kB +7 B (0%)
build/block-library/blocks/freeform/editor.css 2.46 kB +7 B (0%)
build/block-library/blocks/gallery/editor-rtl.css 704 B +15 B (+2%)
build/block-library/blocks/gallery/editor.css 705 B +15 B (+2%)
build/block-library/blocks/group/editor-rtl.css 160 B -158 B (-50%) 🏆
build/block-library/blocks/group/editor.css 160 B -157 B (-50%) 🏆
build/block-library/blocks/navigation-link/editor-rtl.css 626 B +6 B (+1%)
build/block-library/blocks/navigation-link/editor.css 627 B +6 B (+1%)
build/block-library/blocks/navigation-link/style-rtl.css 680 B +9 B (+1%)
build/block-library/blocks/navigation-link/style.css 678 B +10 B (+1%)
build/block-library/blocks/navigation/editor-rtl.css 1.11 kB +24 B (+2%)
build/block-library/blocks/navigation/editor.css 1.11 kB +24 B (+2%)
build/block-library/blocks/page-list/editor-rtl.css 170 B -45 B (-21%) 🎉
build/block-library/blocks/page-list/editor.css 170 B -45 B (-21%) 🎉
build/block-library/blocks/page-list/style-rtl.css 537 B +10 B (+2%)
build/block-library/blocks/page-list/style.css 536 B +10 B (+2%)
build/block-library/blocks/query/editor-rtl.css 820 B +6 B (+1%)
build/block-library/blocks/query/editor.css 819 B +7 B (+1%)
build/block-library/blocks/shortcode/editor-rtl.css 512 B +8 B (+2%)
build/block-library/blocks/shortcode/editor.css 512 B +8 B (+2%)
build/block-library/blocks/social-links/editor-rtl.css 776 B +7 B (+1%)
build/block-library/blocks/social-links/editor.css 776 B +7 B (+1%)
build/block-library/blocks/social-links/style-rtl.css 1.32 kB +8 B (+1%)
build/block-library/blocks/social-links/style.css 1.33 kB +8 B (+1%)
build/block-library/blocks/template-part/editor-rtl.css 552 B -5 B (-1%)
build/block-library/blocks/template-part/editor.css 551 B -5 B (-1%)
build/block-library/editor-rtl.css 9.48 kB -97 B (-1%)
build/block-library/editor.css 9.48 kB -98 B (-1%)
build/block-library/index.js 147 kB +393 B (0%)
build/block-library/style-rtl.css 8.88 kB +31 B (0%)
build/block-library/style.css 8.88 kB +31 B (0%)
build/blocks/index.js 48.3 kB +22 B (0%)
build/components/index.js 284 kB +126 B (0%)
build/components/style-rtl.css 16.2 kB +39 B (0%)
build/components/style.css 16.2 kB +42 B (0%)
build/compose/index.js 11.2 kB +87 B (+1%)
build/core-data/index.js 16.7 kB +3 B (0%)
build/data-controls/index.js 830 B +1 B (0%)
build/deprecated/index.js 768 B -1 B (0%)
build/dom/index.js 4.96 kB +33 B (+1%)
build/edit-navigation/index.js 11.9 kB +19 B (0%)
build/edit-navigation/style-rtl.css 1.31 kB +2 B (0%)
build/edit-navigation/style.css 1.31 kB +3 B (0%)
build/edit-post/index.js 307 kB +168 B (0%)
build/edit-post/style-rtl.css 7.12 kB +259 B (+4%)
build/edit-post/style.css 7.11 kB +253 B (+4%)
build/edit-site/index.js 27.2 kB -31 B (0%)
build/edit-site/style-rtl.css 4.55 kB +57 B (+1%)
build/edit-site/style.css 4.55 kB +57 B (+1%)
build/edit-widgets/index.js 20.2 kB +1 B (0%)
build/editor/index.js 41.9 kB +87 B (0%)
build/editor/style-rtl.css 3.9 kB +8 B (0%)
build/editor/style.css 3.9 kB +8 B (0%)
build/element/index.js 4.61 kB -1 B (0%)
build/format-library/index.js 6.75 kB -7 B (0%)
build/keyboard-shortcuts/index.js 2.53 kB +4 B (0%)
build/nux/index.js 3.41 kB +2 B (0%)
build/primitives/index.js 1.42 kB +1 B (0%)
build/rich-text/index.js 13.3 kB -114 B (-1%)
build/server-side-render/index.js 2.58 kB +1 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.78 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 665 B 0 B
build/block-directory/style-rtl.css 1 kB 0 B
build/block-directory/style.css 1.01 kB 0 B
build/block-library/blocks/archives/editor-rtl.css 61 B 0 B
build/block-library/blocks/archives/editor.css 60 B 0 B
build/block-library/blocks/audio/editor-rtl.css 58 B 0 B
build/block-library/blocks/audio/editor.css 58 B 0 B
build/block-library/blocks/audio/style-rtl.css 112 B 0 B
build/block-library/blocks/audio/style.css 112 B 0 B
build/block-library/blocks/block/editor-rtl.css 161 B 0 B
build/block-library/blocks/block/editor.css 161 B 0 B
build/block-library/blocks/button/editor-rtl.css 475 B 0 B
build/block-library/blocks/button/editor.css 474 B 0 B
build/block-library/blocks/button/style-rtl.css 479 B 0 B
build/block-library/blocks/button/style.css 479 B 0 B
build/block-library/blocks/buttons/editor-rtl.css 315 B 0 B
build/block-library/blocks/buttons/editor.css 315 B 0 B
build/block-library/blocks/buttons/style-rtl.css 364 B 0 B
build/block-library/blocks/buttons/style.css 363 B 0 B
build/block-library/blocks/calendar/style-rtl.css 208 B 0 B
build/block-library/blocks/calendar/style.css 208 B 0 B
build/block-library/blocks/categories/editor-rtl.css 84 B 0 B
build/block-library/blocks/categories/editor.css 83 B 0 B
build/block-library/blocks/categories/style-rtl.css 79 B 0 B
build/block-library/blocks/categories/style.css 79 B 0 B
build/block-library/blocks/code/style-rtl.css 90 B 0 B
build/block-library/blocks/code/style.css 90 B 0 B
build/block-library/blocks/columns/editor-rtl.css 190 B 0 B
build/block-library/blocks/columns/editor.css 190 B 0 B
build/block-library/blocks/columns/style-rtl.css 421 B 0 B
build/block-library/blocks/columns/style.css 421 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.24 kB 0 B
build/block-library/blocks/cover/style.css 1.24 kB 0 B
build/block-library/blocks/embed/editor-rtl.css 486 B 0 B
build/block-library/blocks/embed/editor.css 486 B 0 B
build/block-library/blocks/embed/style-rtl.css 401 B 0 B
build/block-library/blocks/embed/style.css 400 B 0 B
build/block-library/blocks/file/editor-rtl.css 199 B 0 B
build/block-library/blocks/file/editor.css 198 B 0 B
build/block-library/blocks/file/style-rtl.css 248 B 0 B
build/block-library/blocks/file/style.css 248 B 0 B
build/block-library/blocks/gallery/style-rtl.css 1.11 kB 0 B
build/block-library/blocks/gallery/style.css 1.1 kB 0 B
build/block-library/blocks/group/style-rtl.css 57 B 0 B
build/block-library/blocks/group/style.css 57 B 0 B
build/block-library/blocks/heading/editor-rtl.css 129 B 0 B
build/block-library/blocks/heading/editor.css 129 B 0 B
build/block-library/blocks/heading/style-rtl.css 76 B 0 B
build/block-library/blocks/heading/style.css 76 B 0 B
build/block-library/blocks/html/editor-rtl.css 281 B 0 B
build/block-library/blocks/html/editor.css 281 B 0 B
build/block-library/blocks/image/editor-rtl.css 717 B 0 B
build/block-library/blocks/image/editor.css 716 B 0 B
build/block-library/blocks/image/style-rtl.css 476 B 0 B
build/block-library/blocks/image/style.css 478 B 0 B
build/block-library/blocks/latest-comments/editor-rtl.css 159 B 0 B
build/block-library/blocks/latest-comments/editor.css 158 B 0 B
build/block-library/blocks/latest-comments/style-rtl.css 269 B 0 B
build/block-library/blocks/latest-comments/style.css 269 B 0 B
build/block-library/blocks/latest-posts/editor-rtl.css 137 B 0 B
build/block-library/blocks/latest-posts/editor.css 137 B 0 B
build/block-library/blocks/latest-posts/style-rtl.css 523 B 0 B
build/block-library/blocks/latest-posts/style.css 522 B 0 B
build/block-library/blocks/list/editor-rtl.css 65 B 0 B
build/block-library/blocks/list/editor.css 65 B 0 B
build/block-library/blocks/list/style-rtl.css 63 B 0 B
build/block-library/blocks/list/style.css 63 B 0 B
build/block-library/blocks/media-text/editor-rtl.css 191 B 0 B
build/block-library/blocks/media-text/editor.css 191 B 0 B
build/block-library/blocks/media-text/style-rtl.css 535 B 0 B
build/block-library/blocks/media-text/style.css 532 B 0 B
build/block-library/blocks/more/editor-rtl.css 434 B 0 B
build/block-library/blocks/more/editor.css 434 B 0 B
build/block-library/blocks/navigation/style-rtl.css 204 B 0 B
build/block-library/blocks/navigation/style.css 205 B 0 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B 0 B
build/block-library/blocks/nextpage/editor.css 395 B 0 B
build/block-library/blocks/paragraph/editor-rtl.css 157 B 0 B
build/block-library/blocks/paragraph/editor.css 157 B 0 B
build/block-library/blocks/paragraph/style-rtl.css 247 B 0 B
build/block-library/blocks/paragraph/style.css 248 B 0 B
build/block-library/blocks/post-author/editor-rtl.css 209 B 0 B
build/block-library/blocks/post-author/editor.css 209 B 0 B
build/block-library/blocks/post-author/style-rtl.css 183 B 0 B
build/block-library/blocks/post-author/style.css 184 B 0 B
build/block-library/blocks/post-comments-form/style-rtl.css 250 B 0 B
build/block-library/blocks/post-comments-form/style.css 250 B 0 B
build/block-library/blocks/post-content/editor-rtl.css 139 B 0 B
build/block-library/blocks/post-content/editor.css 139 B 0 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B 0 B
build/block-library/blocks/post-excerpt/editor.css 73 B 0 B
build/block-library/blocks/post-featured-image/editor-rtl.css 338 B 0 B
build/block-library/blocks/post-featured-image/editor.css 338 B 0 B
build/block-library/blocks/post-featured-image/style-rtl.css 100 B 0 B
build/block-library/blocks/post-featured-image/style.css 100 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 63 B 0 B
build/block-library/blocks/preformatted/style.css 63 B 0 B
build/block-library/blocks/pullquote/editor-rtl.css 183 B 0 B
build/block-library/blocks/pullquote/editor.css 183 B 0 B
build/block-library/blocks/pullquote/style-rtl.css 318 B 0 B
build/block-library/blocks/pullquote/style.css 318 B 0 B
build/block-library/blocks/query-loop/editor-rtl.css 90 B 0 B
build/block-library/blocks/query-loop/editor.css 89 B 0 B
build/block-library/blocks/query-loop/style-rtl.css 315 B 0 B
build/block-library/blocks/query-loop/style.css 317 B 0 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B 0 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B 0 B
build/block-library/blocks/query-pagination/editor-rtl.css 270 B 0 B
build/block-library/blocks/query-pagination/editor.css 262 B 0 B
build/block-library/blocks/query-pagination/style-rtl.css 168 B 0 B
build/block-library/blocks/query-pagination/style.css 168 B 0 B
build/block-library/blocks/query-title/editor-rtl.css 86 B 0 B
build/block-library/blocks/query-title/editor.css 86 B 0 B
build/block-library/blocks/quote/editor-rtl.css 61 B 0 B
build/block-library/blocks/quote/editor.css 61 B 0 B
build/block-library/blocks/quote/style-rtl.css 169 B 0 B
build/block-library/blocks/quote/style.css 169 B 0 B
build/block-library/blocks/rss/editor-rtl.css 201 B 0 B
build/block-library/blocks/rss/editor.css 202 B 0 B
build/block-library/blocks/rss/style-rtl.css 290 B 0 B
build/block-library/blocks/rss/style.css 290 B 0 B
build/block-library/blocks/search/editor-rtl.css 165 B 0 B
build/block-library/blocks/search/editor.css 165 B 0 B
build/block-library/blocks/search/style-rtl.css 342 B 0 B
build/block-library/blocks/search/style.css 344 B 0 B
build/block-library/blocks/separator/editor-rtl.css 99 B 0 B
build/block-library/blocks/separator/editor.css 99 B 0 B
build/block-library/blocks/separator/style-rtl.css 236 B 0 B
build/block-library/blocks/separator/style.css 236 B 0 B
build/block-library/blocks/site-logo/editor-rtl.css 201 B 0 B
build/block-library/blocks/site-logo/editor.css 201 B 0 B
build/block-library/blocks/site-logo/style-rtl.css 115 B 0 B
build/block-library/blocks/site-logo/style.css 115 B 0 B
build/block-library/blocks/social-link/editor-rtl.css 164 B 0 B
build/block-library/blocks/social-link/editor.css 165 B 0 B
build/block-library/blocks/spacer/editor-rtl.css 317 B 0 B
build/block-library/blocks/spacer/editor.css 317 B 0 B
build/block-library/blocks/spacer/style-rtl.css 48 B 0 B
build/block-library/blocks/spacer/style.css 48 B 0 B
build/block-library/blocks/table/editor-rtl.css 478 B 0 B
build/block-library/blocks/table/editor.css 478 B 0 B
build/block-library/blocks/table/style-rtl.css 402 B 0 B
build/block-library/blocks/table/style.css 402 B 0 B
build/block-library/blocks/tag-cloud/editor-rtl.css 118 B 0 B
build/block-library/blocks/tag-cloud/editor.css 118 B 0 B
build/block-library/blocks/tag-cloud/style-rtl.css 94 B 0 B
build/block-library/blocks/tag-cloud/style.css 94 B 0 B
build/block-library/blocks/term-description/editor-rtl.css 90 B 0 B
build/block-library/blocks/term-description/editor.css 90 B 0 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B 0 B
build/block-library/blocks/text-columns/editor.css 95 B 0 B
build/block-library/blocks/text-columns/style-rtl.css 166 B 0 B
build/block-library/blocks/text-columns/style.css 166 B 0 B
build/block-library/blocks/verse/editor-rtl.css 50 B 0 B
build/block-library/blocks/verse/editor.css 50 B 0 B
build/block-library/blocks/verse/style-rtl.css 87 B 0 B
build/block-library/blocks/verse/style.css 87 B 0 B
build/block-library/blocks/video/editor-rtl.css 504 B 0 B
build/block-library/blocks/video/editor.css 503 B 0 B
build/block-library/blocks/video/style-rtl.css 187 B 0 B
build/block-library/blocks/video/style.css 187 B 0 B
build/block-library/common-rtl.css 1.1 kB 0 B
build/block-library/common.css 1.1 kB 0 B
build/block-library/theme-rtl.css 700 B 0 B
build/block-library/theme.css 701 B 0 B
build/block-serialization-default-parser/index.js 1.87 kB 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/customize-widgets/index.js 3.95 kB 0 B
build/customize-widgets/style-rtl.css 168 B 0 B
build/customize-widgets/style.css 168 B 0 B
build/data/index.js 8.87 kB 0 B
build/date/index.js 31.8 kB 0 B
build/dom-ready/index.js 576 B 0 B
build/edit-widgets/style-rtl.css 3.2 kB 0 B
build/edit-widgets/style.css 3.2 kB 0 B
build/editor/editor-styles-rtl.css 347 B 0 B
build/editor/editor-styles.css 347 B 0 B
build/escape-html/index.js 735 B 0 B
build/format-library/style-rtl.css 637 B 0 B
build/format-library/style.css 639 B 0 B
build/hooks/index.js 2.28 kB 0 B
build/html-entities/index.js 623 B 0 B
build/i18n/index.js 4.01 kB 0 B
build/is-shallow-equal/index.js 698 B 0 B
build/keycodes/index.js 1.95 kB 0 B
build/list-reusable-blocks/index.js 3.14 kB 0 B
build/list-reusable-blocks/style-rtl.css 629 B 0 B
build/list-reusable-blocks/style.css 628 B 0 B
build/media-utils/index.js 5.34 kB 0 B
build/notices/index.js 1.85 kB 0 B
build/nux/style-rtl.css 731 B 0 B
build/nux/style.css 727 B 0 B
build/plugins/index.js 2.89 kB 0 B
build/priority-queue/index.js 791 B 0 B
build/react-i18n/index.js 1.46 kB 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/reusable-blocks/index.js 3.78 kB 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 3.02 kB 0 B
build/viewport/index.js 1.86 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

Copy link
Member

@diegohaz diegohaz left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @sarayourfriend! ❤️

What's the reason for the fallback to View when there's no menu prop? In which case menu will exist and not?

Is this component always intended to be used as a dropdown menu (with a menu button that opens a popover)? I ask this because Reakit's Menu component can only be used like that. Maybe that's the reason for the fallback?

* @param {import('react').Ref<any>} forwardedRef
*/
function Menu( props, forwardedRef ) {
const { children, className, menu, ...otherProps } = useContextSystem(
Copy link
Member

Choose a reason for hiding this comment

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

It looks like this menu is undefined, so View is used instead of ReakitMenu. View isn't a tabbable element. That's why it's not accessible with the keyboard.

How can we inject menu (which I believe would come from useMenuState, right?) into the context system?

);

const resizeListener = usePopoverResizeUpdater( {
onResize: menu?.unstable_update,
Copy link
Member

Choose a reason for hiding this comment

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

If we're going to use unstable features from packages, we should make sure we use the exact version for that package on package.json so as to avoid issues like #23332.

@sarayourfriend
Copy link
Contributor Author

Is this component always intended to be used as a dropdown menu

I'm not sure, @ItsJonQ will have to answer that, but I think your hunch about that being the reason for the fallback makes sense as there is a separate Dropdown component in the new component system.

@ItsJonQ
Copy link

ItsJonQ commented Mar 16, 2021

I'm not sure, @ItsJonQ will have to answer that, but I think your hunch about that being the reason for the fallback makes sense as there is a separate Dropdown component in the new component system.

Haiii!! @sarayourfriend + @diegohaz I can provide some context :).

I created the Menu component to be able to be used in a dropdown or in a sidebar menu (similar to the Material List).

But it sounds like the Reakit menu is intentionally designed to only work within a Dropdown/Popover-like UI, correct?

If so, we may need to create a dedicated component for Sidebar/navigation based menus 🤔

Base automatically changed from add/hooks-heading to trunk March 16, 2021 14:17
@sarayourfriend
Copy link
Contributor Author

If so, we may need to create a dedicated component for Sidebar/navigation based menus 🤔

I think we could solve this by adding tab indexes right? Or are there specific aria roles/attributes we need to apply to a sidebar type menu?

@ItsJonQ
Copy link

ItsJonQ commented Mar 16, 2021

I think we could solve this by adding tab indexes right? Or are there specific aria roles/attributes we need to apply to a sidebar type menu?

I think it's just a tab index change. @diegohaz What do you think :).

Oh! It's worth noting that I previously experienced focus/scroll jumping when I used the Reakit useMenu within a sidebar context. Likely due to the fact that we shouldn't be using this outside of Dropdowns, haha.

@diegohaz
Copy link
Member

diegohaz commented Mar 16, 2021

I think we could solve this by adding tab indexes right? Or are there specific aria roles/attributes we need to apply to a sidebar type menu?

I think it's just a tab index change. @diegohaz What do you think :).

A menu that's always visible is a menubar. From https://www.w3.org/TR/wai-aria-1.1/#menubar:

A presentation of menu that usually remains visible and is usually presented horizontally.

But since we're talking about adding tab indexes, I guess we should use no ARIA in this case. For a static list of actions, just use a static list element.

@sarayourfriend
Copy link
Contributor Author

Okay I tried adding tabIndexes to the component when appropriate... I also added an onSelect prop to the MenuItem to abstract away the need for passing both onClick and onKeyDown... what do y'all think about that @diegohaz and @ItsJonQ ?

@diegohaz
Copy link
Member

diegohaz commented Mar 18, 2021

Okay I tried adding tabIndexes to the component when appropriate... I also added an onSelect prop to the MenuItem to abstract away the need for passing both onClick and onKeyDown... what do y'all think about that @diegohaz and @ItsJonQ ?

I think we should just render a <button> instead of adding tabIndex and working around the click behavior. Is this possible?

@sarayourfriend
Copy link
Contributor Author

I think we should just render a instead of adding tabIndex and working around the click behavior. Is this possible?

You know I thought we were, and indeed we do render a BaseButton but pass as={ View } when the menu context doesn't exist... it should be easy to just pass button there instead of View.

@ItsJonQ
Copy link

ItsJonQ commented Mar 19, 2021

it should be easy to just pass button there instead of View
@sarayourfriend Looks like that worked :D

For your Remove Dropdown awareness from Menu and MenuItem update...
I'm guessing when we add Dropdown, we'll manually rig the reakit/Menu code into these new Menu components? If so, that's a 👍 from me!


(👇 Scroll to bottom for TLDR)

Original Design

This discussion and breakdown was really insightful for me.
(Forgive me for repeating info) The idea behind the original Dropdown and Menu components were for:

  1. Menu = List of actions/navigation items. General Purpose.
  2. Dropdown = General trigger/popover combo, using Menu for actions/navigation.

Even with that in mind, I believe I may have unnecessarily tangled the implementation - that being making Menu "aware" of Dropdown (which @sarayourfriend untangled here).

Naming Conventions

This PR nudged me to look more into the name "Dropdown" vs. "Menu". Unfortunately, it's still unclear 😅 .
Sometimes Menu is a dropdown... sometimes it isn't (depends on the library).

Component Description Other Names
Menu Collection of actionable items Sidebar Menu, List, List Group, Nav Menu
Dropdown Trigger + Popover with a collection of actionable items Menu, Dropdown Menu, Select, Listbox

In the case of Gutenberg and @wordpress/components, "Dropdown" seems to be the preferred/common name for the UI that combines a trigger + popover + actions.

With all that said...


TLDR

Ultimately, we need 2 components:

  1. General list of links/actions (aka. Menu)
  2. Trigger + Popover with a list of links/actions (aka. Dropdown)

We may re-use the Menu UI within Dropdown (and friends), but we don't have to.
They can be separate things.

I think this PR provides us with an opportunity to intentionally define how we want these base level components to be :)

(Doesn't have to be in this PR)


Hope this helps! Love to hear your thoughts ❤️

@sarayourfriend
Copy link
Contributor Author

sarayourfriend commented Mar 19, 2021

I like your summary of the state of things @ItsJonQ. Worst case we can employ these component's polymorphism to reuse them if desired without muddling up their internals.

@diegohaz
Copy link
Member

We already have standard role="menu" and role="menuitem" attributes in HTML, and there are ARIA patterns describing they should behave as a dropdown menu with focus managed via the roving tab index or aria-activedescendant methods. The kind of menu that's not in a dropdown and is always visible — but still manages focus as a menu — is a role="menubar". That's why Reakit uses the names Menu, MenuItem and MenuBar for the equivalent components.

Even though these behaviors are not required, I don't think we should use these roles in a static list with tabbable elements like this component, which would be better described as role="list" and role="listitem" (or just ul and li).

Using the names Menu and MenuItem here is confusing, especially as we get more used to the ARIA patterns. I understand that they make sense on the styling aspect and List and ListItem would be too generic and wouldn't communicate their design properly. But I'd consider naming it differently, like ActionList, StaticMenu, or something else that doesn't cause conflicts with existing patterns.

On the API aspect, I prefer separate components for different semantics. For example, instead of MenuItem being aware of Dropdown, I'd rather have a DropdownItem component.

Alternatively, I've seen other libraries exposing very generic components like Item that could be used like so:

<List>
  <Item />
  <Item />
  <Item />
</List>
<ActionList>
  <Item />
  <Item />
  <Item />
</ActionList>
<Menu>
  <Item />
  <Item />
  <Item />
</Menu>
<DropdownMenu>
  <Item />
  <Item />
  <Item />
</DropdownMenu>

But, instead of Item being aware of all these other container components, it would be really extensible, and there would be an ItemContext that these other components could use to inject props and change the Item semantics.

@sarayourfriend
Copy link
Contributor Author

Major +1 to Diego's solution to this problem.

@alexstine
Copy link
Contributor

I tried testing this, but the G2 components page makes it very hard. I selected Menu and then found the iframe in whhich the content is loaded. When I tried to select the button inside the iframe, nothing happened. The "Code is Poetry" button. It did not appear to toggle aria-expanded either. Maybe I'm looking in the wrong place?

@sarayourfriend
Copy link
Contributor Author

@alexstine As long as you're inside of Storybook you're looking at the right place. We're going to close this PR in favor of #30097 actually so if you have time, testing that PR instead would be better... but it's still in Storybook 😞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Component System WordPress component system Needs Accessibility Feedback Need input from accessibility [Package] Components /packages/components Storybook Storybook and its stories for components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants