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

Navigation Editor: Introduce useMenuEntityProp hook #31132

Merged
merged 3 commits into from
May 10, 2021

Conversation

Mamaduka
Copy link
Member

@Mamaduka Mamaduka commented Apr 23, 2021

Description

Adds useMenuEntityProp as discussed in #30340 (comment). This is a useEntitytProp wrapper hook that encapsulates menu constants and provides an easy way to access/edit individual menu properties.

P.S. Maybe we should also introduce the useSelectedMenuId hook to get menuId from context. Most of the time useSelectedMenuData hook is used for this.

Fixes #30442.

How has this been tested?

Everything should work like before.

  • When changing the menu name, changes should be visible in the heading and menu switcher.
  • "Add new pages" should be saved when clicking the "Save" button.

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 (please manually search all *.native.js files for terms that need renaming or removal).

@github-actions
Copy link

github-actions bot commented Apr 23, 2021

Size Change: +2.94 kB (0%)

Total Size: 1.31 MB

Filename Size Change
build/a11y/index.js 1.11 kB -1 B (0%)
build/annotations/index.js 2.93 kB +2 B (0%)
build/api-fetch/index.js 2.42 kB -1 B (0%)
build/blob/index.js 673 B +1 B (0%)
build/block-directory/index.js 6.6 kB -4 B (0%)
build/block-editor/index.js 116 kB +177 B (0%)
build/block-editor/style-rtl.css 13 kB -28 B (0%)
build/block-editor/style.css 13 kB -26 B (0%)
build/block-library/blocks/navigation/editor-rtl.css 1.32 kB +126 B (+11%) ⚠️
build/block-library/blocks/navigation/editor.css 1.31 kB +126 B (+11%) ⚠️
build/block-library/blocks/navigation/style-rtl.css 1.27 kB +5 B (0%)
build/block-library/blocks/navigation/style.css 1.27 kB +6 B (0%)
build/block-library/blocks/post-comments-form/style-rtl.css 140 B -110 B (-44%) 🎉
build/block-library/blocks/post-comments-form/style.css 140 B -110 B (-44%) 🎉
build/block-library/blocks/post-featured-image/style-rtl.css 119 B +19 B (+19%) ⚠️
build/block-library/blocks/post-featured-image/style.css 119 B +19 B (+19%) ⚠️
build/block-library/common-rtl.css 1.26 kB -49 B (-4%)
build/block-library/common.css 1.26 kB -49 B (-4%)
build/block-library/editor-rtl.css 9.62 kB +82 B (+1%)
build/block-library/editor.css 9.61 kB +86 B (+1%)
build/block-library/index.js 142 kB +108 B (0%)
build/block-library/style-rtl.css 9.62 kB +87 B (+1%)
build/block-library/style.css 9.63 kB +92 B (+1%)
build/block-serialization-default-parser/index.js 1.3 kB -1 B (0%)
build/blocks/index.js 47.1 kB +95 B (0%)
build/components/index.js 188 kB +1.65 kB (+1%)
build/compose/index.js 9.92 kB -39 B (0%)
build/core-data/index.js 12.1 kB -6 B (0%)
build/customize-widgets/index.js 5.99 kB +277 B (+5%) 🔍
build/customize-widgets/style-rtl.css 698 B +32 B (+5%) 🔍
build/customize-widgets/style.css 699 B +32 B (+5%) 🔍
build/data/index.js 7.22 kB -2 B (0%)
build/date/index.js 31.8 kB -2 B (0%)
build/dom/index.js 4.62 kB +17 B (0%)
build/edit-navigation/index.js 13.6 kB -57 B (0%)
build/edit-navigation/style-rtl.css 2.81 kB -46 B (-2%)
build/edit-navigation/style.css 2.81 kB -47 B (-2%)
build/edit-post/index.js 333 kB -63 B (0%)
build/edit-post/style-rtl.css 6.79 kB -187 B (-3%)
build/edit-post/style.css 6.78 kB -183 B (-3%)
build/edit-site/index.js 26.1 kB +339 B (+1%)
build/edit-site/style-rtl.css 4.79 kB -113 B (-2%)
build/edit-site/style.css 4.78 kB -113 B (-2%)
build/edit-widgets/index.js 12.6 kB +139 B (+1%)
build/edit-widgets/style-rtl.css 3.02 kB +45 B (+2%)
build/edit-widgets/style.css 3.03 kB +45 B (+2%)
build/editor/index.js 60.5 kB +62 B (0%)
build/editor/style-rtl.css 3.95 kB +49 B (+1%)
build/editor/style.css 3.95 kB +50 B (+1%)
build/element/index.js 3.44 kB +1 B (0%)
build/i18n/index.js 3.73 kB -1 B (0%)
build/list-reusable-blocks/index.js 2.06 kB -1 B (0%)
build/media-utils/index.js 3.08 kB +1 B (0%)
build/notices/index.js 1.07 kB +2 B (0%)
build/nux/index.js 2.31 kB +3 B (0%)
build/plugins/index.js 2 kB -3 B (0%)
build/primitives/index.js 1.03 kB -6 B (-1%)
build/reusable-blocks/index.js 2.56 kB +2 B (0%)
build/rich-text/index.js 12.2 kB +411 B (+3%)
build/server-side-render/index.js 1.64 kB -2 B (0%)
build/shortcode/index.js 1.68 kB -1 B (0%)
build/token-list/index.js 847 B -1 B (0%)
build/viewport/index.js 1.28 kB -2 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/autop/index.js 2.28 kB 0 B
build/block-directory/style-rtl.css 993 B 0 B
build/block-directory/style.css 995 B 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 515 B 0 B
build/block-library/blocks/button/style.css 515 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 368 B 0 B
build/block-library/blocks/buttons/style.css 368 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 422 B 0 B
build/block-library/blocks/columns/style.css 422 B 0 B
build/block-library/blocks/cover/editor-rtl.css 603 B 0 B
build/block-library/blocks/cover/editor.css 604 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.22 kB 0 B
build/block-library/blocks/cover/style.css 1.22 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 301 B 0 B
build/block-library/blocks/file/editor.css 300 B 0 B
build/block-library/blocks/file/frontend.js 773 B 0 B
build/block-library/blocks/file/style-rtl.css 255 B 0 B
build/block-library/blocks/file/style.css 255 B 0 B
build/block-library/blocks/freeform/editor-rtl.css 2.45 kB 0 B
build/block-library/blocks/freeform/editor.css 2.45 kB 0 B
build/block-library/blocks/gallery/editor-rtl.css 704 B 0 B
build/block-library/blocks/gallery/editor.css 705 B 0 B
build/block-library/blocks/gallery/style-rtl.css 1.06 kB 0 B
build/block-library/blocks/gallery/style.css 1.05 kB 0 B
build/block-library/blocks/group/editor-rtl.css 160 B 0 B
build/block-library/blocks/group/editor.css 160 B 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/style-rtl.css 281 B 0 B
build/block-library/blocks/latest-comments/style.css 282 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/legacy-widget/editor-rtl.css 557 B 0 B
build/block-library/blocks/legacy-widget/editor.css 557 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 176 B 0 B
build/block-library/blocks/media-text/editor.css 176 B 0 B
build/block-library/blocks/media-text/style-rtl.css 492 B 0 B
build/block-library/blocks/media-text/style.css 489 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-link/editor-rtl.css 617 B 0 B
build/block-library/blocks/navigation-link/editor.css 619 B 0 B
build/block-library/blocks/navigation-link/style-rtl.css 94 B 0 B
build/block-library/blocks/navigation-link/style.css 94 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/page-list/editor-rtl.css 239 B 0 B
build/block-library/blocks/page-list/editor.css 240 B 0 B
build/block-library/blocks/page-list/style-rtl.css 167 B 0 B
build/block-library/blocks/page-list/style.css 167 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/style-rtl.css 362 B 0 B
build/block-library/blocks/post-comments/style.css 362 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-excerpt/style-rtl.css 69 B 0 B
build/block-library/blocks/post-excerpt/style.css 69 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-title/style-rtl.css 60 B 0 B
build/block-library/blocks/post-title/style.css 60 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 103 B 0 B
build/block-library/blocks/preformatted/style.css 103 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 83 B 0 B
build/block-library/blocks/query-loop/editor.css 82 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/query/editor-rtl.css 131 B 0 B
build/block-library/blocks/query/editor.css 132 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 189 B 0 B
build/block-library/blocks/search/editor.css 189 B 0 B
build/block-library/blocks/search/style-rtl.css 359 B 0 B
build/block-library/blocks/search/style.css 362 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 251 B 0 B
build/block-library/blocks/separator/style.css 251 B 0 B
build/block-library/blocks/shortcode/editor-rtl.css 512 B 0 B
build/block-library/blocks/shortcode/editor.css 512 B 0 B
build/block-library/blocks/site-logo/editor-rtl.css 440 B 0 B
build/block-library/blocks/site-logo/editor.css 441 B 0 B
build/block-library/blocks/site-logo/style-rtl.css 154 B 0 B
build/block-library/blocks/site-logo/style.css 154 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/social-links/editor-rtl.css 796 B 0 B
build/block-library/blocks/social-links/editor.css 795 B 0 B
build/block-library/blocks/social-links/style-rtl.css 1.32 kB 0 B
build/block-library/blocks/social-links/style.css 1.33 kB 0 B
build/block-library/blocks/spacer/editor-rtl.css 308 B 0 B
build/block-library/blocks/spacer/editor.css 308 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 485 B 0 B
build/block-library/blocks/table/style.css 485 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/template-part/editor-rtl.css 551 B 0 B
build/block-library/blocks/template-part/editor.css 550 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/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 569 B 0 B
build/block-library/blocks/video/editor.css 570 B 0 B
build/block-library/blocks/video/style-rtl.css 169 B 0 B
build/block-library/blocks/video/style.css 169 B 0 B
build/block-library/reset-rtl.css 506 B 0 B
build/block-library/reset.css 507 B 0 B
build/block-library/theme-rtl.css 692 B 0 B
build/block-library/theme.css 693 B 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/components/style-rtl.css 16.2 kB 0 B
build/components/style.css 16.2 kB 0 B
build/data-controls/index.js 830 B 0 B
build/deprecated/index.js 738 B 0 B
build/dom-ready/index.js 576 B 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 0 B
build/escape-html/index.js 739 B 0 B
build/format-library/index.js 5.68 kB 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 1.76 kB 0 B
build/html-entities/index.js 628 B 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 1.65 kB 0 B
build/keycodes/index.js 1.43 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/nux/style-rtl.css 718 B 0 B
build/nux/style.css 716 B 0 B
build/priority-queue/index.js 791 B 0 B
build/react-i18n/index.js 924 B 0 B
build/redux-routine/index.js 2.82 kB 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/url/index.js 1.95 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/widgets/index.js 1.68 kB 0 B
build/wordcount/index.js 1.24 kB 0 B

compressed-size-action

@Mamaduka
Copy link
Member Author

I think this also fixes #30425.

@talldan
Copy link
Contributor

talldan commented Apr 27, 2021

Maybe we should also introduce the useSelectedMenuId hook to get menuId from context.

There's also #22623, which might influence how the selected menu id works. An option for solving that is to move the selected menu id to the store, and then use the persistence plugin (https://github.com/WordPress/gutenberg/tree/trunk/packages/data/src/plugins/persistence) to sync the value to local storage.

@Mamaduka Mamaduka force-pushed the add/use-menu-entity-prop branch from 32c0c39 to 7c295dd Compare May 5, 2021 05:32
@Mamaduka
Copy link
Member Author

Mamaduka commented May 5, 2021

Hi, @talldan

Updated PR to reflect changes from #31320.

Copy link
Contributor

@getdave getdave left a comment

Choose a reason for hiding this comment

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

I tested this manually in the UI and didn't spot any regressions.

That said I'm not clear on

"Add new pages" should be saved when clicking the "Save" button.

From the code it looks like previously when you toggled Add new pages in the Inspector sidebar the menu was automatically saved. Am I right in thinking this PR alters that behaviour so you now manually need to click Save?

If so it feels like that might want to be a separate PR along with a rationale for why this is done. I may have the wrong end of this stick however 😄

With a little more info I would be happy to approve this one.

@Mamaduka
Copy link
Member Author

Mamaduka commented May 7, 2021

From the code it looks like previously when you toggled Add new pages in the Inspector sidebar the menu was automatically saved. Am I right in thinking this PR alters that behaviour so you now manually need to click Save?

Sorry about that. I accidentally fixed #30425 when refactoring to use the new hook. The issue also has PR (#30446) that takes a different approach by moving state up the level and using the useMenuEntity hook.

Happy to remove the "Add new pages" part and create separate PR for the mentioned issue.

Copy link
Contributor

@getdave getdave left a comment

Choose a reason for hiding this comment

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

No worries. Thanks for clarifying.

Happy to remove the "Add new pages" part and create separate PR for the mentioned issue.

Although it seems a bit tedious it might be easier to review in isolation 👍

I'll approve this PR because I know that the saving of the toggle only happened when I clicked the Save button. I'll leave it to you as to whether you want to spin up a separate PR instead.

@Mamaduka
Copy link
Member Author

Hi, @getdave

I reverted changes for "Add new pages" and will create a separated PR in a bit.
I am going to merge this one once all checks are green.

Thanks again for the review.

@Mamaduka Mamaduka merged commit a85b8eb into trunk May 10, 2021
@Mamaduka Mamaduka deleted the add/use-menu-entity-prop branch May 10, 2021 05:49
@github-actions github-actions bot added this to the Gutenberg 10.7 milestone May 10, 2021
@getdave
Copy link
Contributor

getdave commented May 10, 2021

I reverted changes for "Add new pages" and will create a separated PR in a bit.

Sure thing. Let me know and I'll happily review.

@Mamaduka
Copy link
Member Author

Thanks, @getdave

Here's new PR #31643.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Naviagion edtior - encapsulate menu constants inside use-menu-entity hook
3 participants