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

Refactor document actions to handle template part titles #26043

Merged
merged 2 commits into from
Oct 15, 2020

Conversation

noahtallen
Copy link
Member

Description

Resolves #25878. This refactors the DocumentActions component in the following ways:

  1. Remove the prop for a template object
  2. Add props for entityTitle and entityLabel so that the component can be used for generic entities.
  3. Pass React children to the dropdown component so that the actions area is not tightly coupled to the content which could be shown there.

We then utilize these changes in the header component so that:

  1. The entityTitle can changed based on the entity being edited (so it now shows the template part slug when zoomed into a template part).
  2. Only render dropdown content when displaying a template so that we don't show a unnecessary content for the template part.

Visually, the only difference should be that when you switch to a template part in the sidebar, it now displays the template part slug as the document title.

How has this been tested?

Locally in edit site.

Screenshots

2020-10-12 15 52 41

Types of changes

Enhancement

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • 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.

@noahtallen noahtallen added [Type] Enhancement A suggestion for improvement. [Type] Code Quality Issues or PRs that relate to code quality [Feature] Full Site Editing [Package] Edit Site /packages/edit-site labels Oct 12, 2020
@noahtallen noahtallen self-assigned this Oct 12, 2020
@github-actions
Copy link

github-actions bot commented Oct 12, 2020

Size Change: +167 B (0%)

Total Size: 1.19 MB

Filename Size Change
build/edit-site/index.js 21.3 kB +167 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.54 kB 0 B
build/api-fetch/index.js 3.35 kB 0 B
build/autop/index.js 2.72 kB 0 B
build/blob/index.js 668 B 0 B
build/block-directory/index.js 8.6 kB 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/index.js 130 kB 0 B
build/block-editor/style-rtl.css 10.9 kB 0 B
build/block-editor/style.css 10.9 kB 0 B
build/block-library/editor-rtl.css 8.65 kB 0 B
build/block-library/editor.css 8.65 kB 0 B
build/block-library/index.js 142 kB 0 B
build/block-library/style-rtl.css 7.71 kB 0 B
build/block-library/style.css 7.71 kB 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 B 0 B
build/block-serialization-default-parser/index.js 1.78 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 47.6 kB 0 B
build/components/index.js 169 kB 0 B
build/components/style-rtl.css 15.4 kB 0 B
build/components/style.css 15.4 kB 0 B
build/compose/index.js 9.63 kB 0 B
build/core-data/index.js 12.1 kB 0 B
build/data-controls/index.js 684 B 0 B
build/data/index.js 8.63 kB 0 B
build/date/index.js 31.9 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 4.43 kB 0 B
build/edit-navigation/index.js 10.6 kB 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/edit-post/index.js 306 kB 0 B
build/edit-post/style-rtl.css 6.37 kB 0 B
build/edit-post/style.css 6.35 kB 0 B
build/edit-site/style-rtl.css 3.81 kB 0 B
build/edit-site/style.css 3.82 kB 0 B
build/edit-widgets/index.js 21.6 kB 0 B
build/edit-widgets/style-rtl.css 3.09 kB 0 B
build/edit-widgets/style.css 3.09 kB 0 B
build/editor/editor-styles-rtl.css 480 B 0 B
build/editor/editor-styles.css 482 B 0 B
build/editor/index.js 42.4 kB 0 B
build/editor/style-rtl.css 3.85 kB 0 B
build/editor/style.css 3.84 kB 0 B
build/element/index.js 4.45 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.49 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 1.74 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.54 kB 0 B
build/is-shallow-equal/index.js 709 B 0 B
build/keyboard-shortcuts/index.js 2.39 kB 0 B
build/keycodes/index.js 1.85 kB 0 B
build/list-reusable-blocks/index.js 3.02 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.12 kB 0 B
build/notices/index.js 1.69 kB 0 B
build/nux/index.js 3.27 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.44 kB 0 B
build/primitives/index.js 1.34 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/reusable-blocks/index.js 3.04 kB 0 B
build/rich-text/index.js 13 kB 0 B
build/server-side-render/index.js 2.6 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.24 kB 0 B
build/url/index.js 4.07 kB 0 B
build/viewport/index.js 1.75 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@noahtallen noahtallen force-pushed the try/update-template-part-name-in-header branch from bddc5e5 to 3e38b81 Compare October 12, 2020 23:56
Copy link
Member

@vindl vindl left a comment

Choose a reason for hiding this comment

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

This is working well for me but I left one question about organizing code.

@Copons
Copy link
Contributor

Copons commented Oct 13, 2020

Note: this could use the same "View in navigation" flow introduced in #26003, which means that eventually template parts too would maybe need a dropdown.
(Maybe they could have a description/excerpt as well?)

@noahtallen
Copy link
Member Author

which means that eventually template parts too would maybe need a dropdown.

Unsure, I don't think there have been any design explorations on this yet

Copy link
Contributor

@jeyip jeyip left a comment

Choose a reason for hiding this comment

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

I can confirm that this works as expected in Chrome, Firefox, Safari, Edge, and IE11. 🚀

@noahtallen noahtallen force-pushed the try/update-template-part-name-in-header branch 2 times, most recently from 9eb817c to 5dc7257 Compare October 14, 2020 23:23
@vindl
Copy link
Member

vindl commented Oct 15, 2020

This works as expected but the PR needs to be rebased now.

@noahtallen noahtallen force-pushed the try/update-template-part-name-in-header branch from 5dc7257 to 5789a7f Compare October 15, 2020 19:51
Copy link
Member

@vindl vindl left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@noahtallen noahtallen merged commit f1092c2 into master Oct 15, 2020
@noahtallen noahtallen deleted the try/update-template-part-name-in-header branch October 15, 2020 20:28
@github-actions github-actions bot added this to the Gutenberg 9.2 milestone Oct 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Edit Site /packages/edit-site [Type] Code Quality Issues or PRs that relate to code quality [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document name area does not update with template part name
5 participants