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

Site Editor: Add "Added by" description to template part navigation sidebar #48732

Merged
merged 11 commits into from
Mar 15, 2023

Conversation

kevin940726
Copy link
Member

What?

Close #48483. Add "Added by" description to the template part navigation sidebar.

Why?

See #48483.

How?

In order to reuse the logic in <AddedBy>, I extract them into a hook useAddedBy, and use that in the sidebar. Open to ideas to make it more simple and more elegant!

Testing Instructions

  1. Go to Site Editor
  2. Click "Template parts" in the sidebar.
  3. Click on any template part, and expect to see the "Added by" description.

Testing Instructions for Keyboard

  1. Go to the Site Editor with template parts: /wp-admin/site-editor.php?canvas=view&postType=wp_template_part&path=%2Fwp_template_part
  2. Press Tab four times to navigate to the template parts list
  3. Enter either of the template part, expect the screen readers to announce the "Added by" description in the sidebar.

Screenshots or screencast

image

image

@kevin940726 kevin940726 added the [Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") label Mar 3, 2023
@kevin940726 kevin940726 self-assigned this Mar 3, 2023
@kevin940726
Copy link
Member Author

Question: Do we also want to display the icon as in the template parts list view? It could help distinguish different types of authors: theme, plugin, site, or user.

@github-actions
Copy link

github-actions bot commented Mar 3, 2023

Size Change: +1.74 kB (0%)

Total Size: 1.34 MB

Filename Size Change
build/block-editor/index.min.js 197 kB +113 B (0%)
build/block-editor/style-rtl.css 14.4 kB +4 B (0%)
build/block-editor/style.css 14.4 kB +4 B (0%)
build/block-library/blocks/cover/style-rtl.css 1.6 kB +25 B (+2%)
build/block-library/blocks/cover/style.css 1.59 kB +25 B (+2%)
build/block-library/blocks/post-featured-image/style-rtl.css 322 B +4 B (+1%)
build/block-library/blocks/post-featured-image/style.css 322 B +4 B (+1%)
build/block-library/index.min.js 201 kB +317 B (0%)
build/block-library/style-rtl.css 12.7 kB +25 B (0%)
build/block-library/style.css 12.7 kB +24 B (0%)
build/blocks/index.min.js 51 kB -10 B (0%)
build/components/index.min.js 208 kB +79 B (0%)
build/components/style-rtl.css 11.7 kB +23 B (0%)
build/components/style.css 11.7 kB +22 B (0%)
build/core-data/index.min.js 16.3 kB +48 B (0%)
build/edit-post/index.min.js 34.8 kB +10 B (0%)
build/edit-post/style-rtl.css 7.55 kB +18 B (0%)
build/edit-post/style.css 7.54 kB +17 B (0%)
build/edit-site/index.min.js 65 kB +792 B (+1%)
build/edit-site/style-rtl.css 10.2 kB +85 B (+1%)
build/edit-site/style.css 10.2 kB +88 B (+1%)
build/edit-widgets/style-rtl.css 4.56 kB +9 B (0%)
build/edit-widgets/style.css 4.56 kB +9 B (0%)
build/editor/index.min.js 45.8 kB +6 B (0%)
ℹ️ View Unchanged
Filename Size
build/a11y/index.min.js 993 B
build/annotations/index.min.js 2.78 kB
build/api-fetch/index.min.js 2.27 kB
build/autop/index.min.js 2.15 kB
build/blob/index.min.js 483 B
build/block-directory/index.min.js 7.2 kB
build/block-directory/style-rtl.css 1.04 kB
build/block-directory/style.css 1.04 kB
build/block-editor/content-rtl.css 4.11 kB
build/block-editor/content.css 4.1 kB
build/block-editor/default-editor-styles-rtl.css 403 B
build/block-editor/default-editor-styles.css 403 B
build/block-library/blocks/archives/editor-rtl.css 61 B
build/block-library/blocks/archives/editor.css 60 B
build/block-library/blocks/archives/style-rtl.css 90 B
build/block-library/blocks/archives/style.css 90 B
build/block-library/blocks/audio/editor-rtl.css 150 B
build/block-library/blocks/audio/editor.css 150 B
build/block-library/blocks/audio/style-rtl.css 122 B
build/block-library/blocks/audio/style.css 122 B
build/block-library/blocks/audio/theme-rtl.css 138 B
build/block-library/blocks/audio/theme.css 138 B
build/block-library/blocks/avatar/editor-rtl.css 116 B
build/block-library/blocks/avatar/editor.css 116 B
build/block-library/blocks/avatar/style-rtl.css 91 B
build/block-library/blocks/avatar/style.css 91 B
build/block-library/blocks/block/editor-rtl.css 305 B
build/block-library/blocks/block/editor.css 305 B
build/block-library/blocks/button/editor-rtl.css 587 B
build/block-library/blocks/button/editor.css 587 B
build/block-library/blocks/button/style-rtl.css 628 B
build/block-library/blocks/button/style.css 627 B
build/block-library/blocks/buttons/editor-rtl.css 337 B
build/block-library/blocks/buttons/editor.css 337 B
build/block-library/blocks/buttons/style-rtl.css 332 B
build/block-library/blocks/buttons/style.css 332 B
build/block-library/blocks/calendar/style-rtl.css 239 B
build/block-library/blocks/calendar/style.css 239 B
build/block-library/blocks/categories/editor-rtl.css 84 B
build/block-library/blocks/categories/editor.css 83 B
build/block-library/blocks/categories/style-rtl.css 100 B
build/block-library/blocks/categories/style.css 100 B
build/block-library/blocks/code/editor-rtl.css 53 B
build/block-library/blocks/code/editor.css 53 B
build/block-library/blocks/code/style-rtl.css 121 B
build/block-library/blocks/code/style.css 121 B
build/block-library/blocks/code/theme-rtl.css 124 B
build/block-library/blocks/code/theme.css 124 B
build/block-library/blocks/columns/editor-rtl.css 108 B
build/block-library/blocks/columns/editor.css 108 B
build/block-library/blocks/columns/style-rtl.css 406 B
build/block-library/blocks/columns/style.css 406 B
build/block-library/blocks/comment-author-avatar/editor-rtl.css 125 B
build/block-library/blocks/comment-author-avatar/editor.css 125 B
build/block-library/blocks/comment-content/style-rtl.css 92 B
build/block-library/blocks/comment-content/style.css 92 B
build/block-library/blocks/comment-template/style-rtl.css 199 B
build/block-library/blocks/comment-template/style.css 198 B
build/block-library/blocks/comments-pagination-numbers/editor-rtl.css 123 B
build/block-library/blocks/comments-pagination-numbers/editor.css 121 B
build/block-library/blocks/comments-pagination/editor-rtl.css 222 B
build/block-library/blocks/comments-pagination/editor.css 209 B
build/block-library/blocks/comments-pagination/style-rtl.css 235 B
build/block-library/blocks/comments-pagination/style.css 231 B
build/block-library/blocks/comments-title/editor-rtl.css 75 B
build/block-library/blocks/comments-title/editor.css 75 B
build/block-library/blocks/comments/editor-rtl.css 840 B
build/block-library/blocks/comments/editor.css 839 B
build/block-library/blocks/comments/style-rtl.css 637 B
build/block-library/blocks/comments/style.css 636 B
build/block-library/blocks/cover/editor-rtl.css 612 B
build/block-library/blocks/cover/editor.css 613 B
build/block-library/blocks/embed/editor-rtl.css 293 B
build/block-library/blocks/embed/editor.css 293 B
build/block-library/blocks/embed/style-rtl.css 410 B
build/block-library/blocks/embed/style.css 410 B
build/block-library/blocks/embed/theme-rtl.css 138 B
build/block-library/blocks/embed/theme.css 138 B
build/block-library/blocks/file/editor-rtl.css 300 B
build/block-library/blocks/file/editor.css 300 B
build/block-library/blocks/file/style-rtl.css 265 B
build/block-library/blocks/file/style.css 265 B
build/block-library/blocks/file/view.min.js 353 B
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB
build/block-library/blocks/freeform/editor.css 2.44 kB
build/block-library/blocks/gallery/editor-rtl.css 984 B
build/block-library/blocks/gallery/editor.css 988 B
build/block-library/blocks/gallery/style-rtl.css 1.55 kB
build/block-library/blocks/gallery/style.css 1.55 kB
build/block-library/blocks/gallery/theme-rtl.css 122 B
build/block-library/blocks/gallery/theme.css 122 B
build/block-library/blocks/group/editor-rtl.css 654 B
build/block-library/blocks/group/editor.css 654 B
build/block-library/blocks/group/style-rtl.css 57 B
build/block-library/blocks/group/style.css 57 B
build/block-library/blocks/group/theme-rtl.css 78 B
build/block-library/blocks/group/theme.css 78 B
build/block-library/blocks/heading/style-rtl.css 76 B
build/block-library/blocks/heading/style.css 76 B
build/block-library/blocks/html/editor-rtl.css 332 B
build/block-library/blocks/html/editor.css 333 B
build/block-library/blocks/image/editor-rtl.css 830 B
build/block-library/blocks/image/editor.css 829 B
build/block-library/blocks/image/style-rtl.css 652 B
build/block-library/blocks/image/style.css 652 B
build/block-library/blocks/image/theme-rtl.css 137 B
build/block-library/blocks/image/theme.css 137 B
build/block-library/blocks/latest-comments/style-rtl.css 357 B
build/block-library/blocks/latest-comments/style.css 357 B
build/block-library/blocks/latest-posts/editor-rtl.css 213 B
build/block-library/blocks/latest-posts/editor.css 212 B
build/block-library/blocks/latest-posts/style-rtl.css 478 B
build/block-library/blocks/latest-posts/style.css 478 B
build/block-library/blocks/list/style-rtl.css 88 B
build/block-library/blocks/list/style.css 88 B
build/block-library/blocks/media-text/editor-rtl.css 266 B
build/block-library/blocks/media-text/editor.css 263 B
build/block-library/blocks/media-text/style-rtl.css 507 B
build/block-library/blocks/media-text/style.css 505 B
build/block-library/blocks/more/editor-rtl.css 431 B
build/block-library/blocks/more/editor.css 431 B
build/block-library/blocks/navigation-link/editor-rtl.css 716 B
build/block-library/blocks/navigation-link/editor.css 715 B
build/block-library/blocks/navigation-link/style-rtl.css 115 B
build/block-library/blocks/navigation-link/style.css 115 B
build/block-library/blocks/navigation-submenu/editor-rtl.css 299 B
build/block-library/blocks/navigation-submenu/editor.css 299 B
build/block-library/blocks/navigation/editor-rtl.css 2.13 kB
build/block-library/blocks/navigation/editor.css 2.14 kB
build/block-library/blocks/navigation/style-rtl.css 2.22 kB
build/block-library/blocks/navigation/style.css 2.2 kB
build/block-library/blocks/navigation/view-modal.min.js 2.81 kB
build/block-library/blocks/navigation/view.min.js 447 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B
build/block-library/blocks/nextpage/editor.css 395 B
build/block-library/blocks/page-list/editor-rtl.css 401 B
build/block-library/blocks/page-list/editor.css 401 B
build/block-library/blocks/page-list/style-rtl.css 175 B
build/block-library/blocks/page-list/style.css 175 B
build/block-library/blocks/paragraph/editor-rtl.css 174 B
build/block-library/blocks/paragraph/editor.css 174 B
build/block-library/blocks/paragraph/style-rtl.css 279 B
build/block-library/blocks/paragraph/style.css 281 B
build/block-library/blocks/post-author/style-rtl.css 175 B
build/block-library/blocks/post-author/style.css 176 B
build/block-library/blocks/post-comments-form/editor-rtl.css 96 B
build/block-library/blocks/post-comments-form/editor.css 96 B
build/block-library/blocks/post-comments-form/style-rtl.css 501 B
build/block-library/blocks/post-comments-form/style.css 501 B
build/block-library/blocks/post-date/style-rtl.css 61 B
build/block-library/blocks/post-date/style.css 61 B
build/block-library/blocks/post-excerpt/editor-rtl.css 71 B
build/block-library/blocks/post-excerpt/editor.css 71 B
build/block-library/blocks/post-excerpt/style-rtl.css 134 B
build/block-library/blocks/post-excerpt/style.css 134 B
build/block-library/blocks/post-featured-image/editor-rtl.css 586 B
build/block-library/blocks/post-featured-image/editor.css 584 B
build/block-library/blocks/post-navigation-link/style-rtl.css 153 B
build/block-library/blocks/post-navigation-link/style.css 153 B
build/block-library/blocks/post-template/editor-rtl.css 99 B
build/block-library/blocks/post-template/editor.css 98 B
build/block-library/blocks/post-template/style-rtl.css 282 B
build/block-library/blocks/post-template/style.css 282 B
build/block-library/blocks/post-terms/style-rtl.css 96 B
build/block-library/blocks/post-terms/style.css 96 B
build/block-library/blocks/post-title/style-rtl.css 100 B
build/block-library/blocks/post-title/style.css 100 B
build/block-library/blocks/preformatted/style-rtl.css 103 B
build/block-library/blocks/preformatted/style.css 103 B
build/block-library/blocks/pullquote/editor-rtl.css 135 B
build/block-library/blocks/pullquote/editor.css 135 B
build/block-library/blocks/pullquote/style-rtl.css 326 B
build/block-library/blocks/pullquote/style.css 325 B
build/block-library/blocks/pullquote/theme-rtl.css 167 B
build/block-library/blocks/pullquote/theme.css 167 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B
build/block-library/blocks/query-pagination/editor-rtl.css 221 B
build/block-library/blocks/query-pagination/editor.css 211 B
build/block-library/blocks/query-pagination/style-rtl.css 288 B
build/block-library/blocks/query-pagination/style.css 284 B
build/block-library/blocks/query-title/style-rtl.css 63 B
build/block-library/blocks/query-title/style.css 63 B
build/block-library/blocks/query/editor-rtl.css 463 B
build/block-library/blocks/query/editor.css 463 B
build/block-library/blocks/quote/style-rtl.css 222 B
build/block-library/blocks/quote/style.css 222 B
build/block-library/blocks/quote/theme-rtl.css 223 B
build/block-library/blocks/quote/theme.css 226 B
build/block-library/blocks/read-more/style-rtl.css 132 B
build/block-library/blocks/read-more/style.css 132 B
build/block-library/blocks/rss/editor-rtl.css 149 B
build/block-library/blocks/rss/editor.css 149 B
build/block-library/blocks/rss/style-rtl.css 289 B
build/block-library/blocks/rss/style.css 288 B
build/block-library/blocks/search/editor-rtl.css 165 B
build/block-library/blocks/search/editor.css 165 B
build/block-library/blocks/search/style-rtl.css 409 B
build/block-library/blocks/search/style.css 406 B
build/block-library/blocks/search/theme-rtl.css 114 B
build/block-library/blocks/search/theme.css 114 B
build/block-library/blocks/separator/editor-rtl.css 146 B
build/block-library/blocks/separator/editor.css 146 B
build/block-library/blocks/separator/style-rtl.css 234 B
build/block-library/blocks/separator/style.css 234 B
build/block-library/blocks/separator/theme-rtl.css 194 B
build/block-library/blocks/separator/theme.css 194 B
build/block-library/blocks/shortcode/editor-rtl.css 474 B
build/block-library/blocks/shortcode/editor.css 474 B
build/block-library/blocks/site-logo/editor-rtl.css 489 B
build/block-library/blocks/site-logo/editor.css 489 B
build/block-library/blocks/site-logo/style-rtl.css 203 B
build/block-library/blocks/site-logo/style.css 203 B
build/block-library/blocks/site-tagline/editor-rtl.css 86 B
build/block-library/blocks/site-tagline/editor.css 86 B
build/block-library/blocks/site-title/editor-rtl.css 116 B
build/block-library/blocks/site-title/editor.css 116 B
build/block-library/blocks/site-title/style-rtl.css 57 B
build/block-library/blocks/site-title/style.css 57 B
build/block-library/blocks/social-link/editor-rtl.css 184 B
build/block-library/blocks/social-link/editor.css 184 B
build/block-library/blocks/social-links/editor-rtl.css 674 B
build/block-library/blocks/social-links/editor.css 673 B
build/block-library/blocks/social-links/style-rtl.css 1.4 kB
build/block-library/blocks/social-links/style.css 1.39 kB
build/block-library/blocks/spacer/editor-rtl.css 332 B
build/block-library/blocks/spacer/editor.css 332 B
build/block-library/blocks/spacer/style-rtl.css 48 B
build/block-library/blocks/spacer/style.css 48 B
build/block-library/blocks/table/editor-rtl.css 433 B
build/block-library/blocks/table/editor.css 433 B
build/block-library/blocks/table/style-rtl.css 651 B
build/block-library/blocks/table/style.css 650 B
build/block-library/blocks/table/theme-rtl.css 157 B
build/block-library/blocks/table/theme.css 157 B
build/block-library/blocks/tag-cloud/style-rtl.css 251 B
build/block-library/blocks/tag-cloud/style.css 253 B
build/block-library/blocks/template-part/editor-rtl.css 404 B
build/block-library/blocks/template-part/editor.css 404 B
build/block-library/blocks/template-part/theme-rtl.css 101 B
build/block-library/blocks/template-part/theme.css 101 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B
build/block-library/blocks/text-columns/editor.css 95 B
build/block-library/blocks/text-columns/style-rtl.css 166 B
build/block-library/blocks/text-columns/style.css 166 B
build/block-library/blocks/verse/style-rtl.css 99 B
build/block-library/blocks/verse/style.css 99 B
build/block-library/blocks/video/editor-rtl.css 552 B
build/block-library/blocks/video/editor.css 555 B
build/block-library/blocks/video/style-rtl.css 179 B
build/block-library/blocks/video/style.css 179 B
build/block-library/blocks/video/theme-rtl.css 139 B
build/block-library/blocks/video/theme.css 139 B
build/block-library/classic-rtl.css 179 B
build/block-library/classic.css 179 B
build/block-library/common-rtl.css 1.11 kB
build/block-library/common.css 1.11 kB
build/block-library/editor-elements-rtl.css 75 B
build/block-library/editor-elements.css 75 B
build/block-library/editor-rtl.css 11.6 kB
build/block-library/editor.css 11.6 kB
build/block-library/elements-rtl.css 54 B
build/block-library/elements.css 54 B
build/block-library/reset-rtl.css 478 B
build/block-library/reset.css 478 B
build/block-library/theme-rtl.css 698 B
build/block-library/theme.css 703 B
build/block-serialization-default-parser/index.min.js 1.13 kB
build/block-serialization-spec-parser/index.min.js 2.83 kB
build/compose/index.min.js 12.4 kB
build/customize-widgets/index.min.js 12.2 kB
build/customize-widgets/style-rtl.css 1.41 kB
build/customize-widgets/style.css 1.41 kB
build/data-controls/index.min.js 663 B
build/data/index.min.js 8.58 kB
build/date/index.min.js 40.4 kB
build/deprecated/index.min.js 518 B
build/dom-ready/index.min.js 336 B
build/dom/index.min.js 4.72 kB
build/edit-post/classic-rtl.css 571 B
build/edit-post/classic.css 571 B
build/edit-widgets/index.min.js 17.3 kB
build/editor/style-rtl.css 3.54 kB
build/editor/style.css 3.53 kB
build/element/index.min.js 4.95 kB
build/escape-html/index.min.js 548 B
build/format-library/index.min.js 7.26 kB
build/format-library/style-rtl.css 557 B
build/format-library/style.css 556 B
build/hooks/index.min.js 1.66 kB
build/html-entities/index.min.js 454 B
build/i18n/index.min.js 3.79 kB
build/is-shallow-equal/index.min.js 535 B
build/keyboard-shortcuts/index.min.js 1.79 kB
build/keycodes/index.min.js 1.94 kB
build/list-reusable-blocks/index.min.js 2.14 kB
build/list-reusable-blocks/style-rtl.css 865 B
build/list-reusable-blocks/style.css 865 B
build/media-utils/index.min.js 2.99 kB
build/notices/index.min.js 977 B
build/plugins/index.min.js 1.95 kB
build/preferences-persistence/index.min.js 2.23 kB
build/preferences/index.min.js 1.35 kB
build/primitives/index.min.js 960 B
build/priority-queue/index.min.js 1.52 kB
build/private-apis/index.min.js 937 B
build/react-i18n/index.min.js 702 B
build/react-refresh-entry/index.min.js 8.44 kB
build/react-refresh-runtime/index.min.js 7.31 kB
build/redux-routine/index.min.js 2.75 kB
build/reusable-blocks/index.min.js 2.26 kB
build/reusable-blocks/style-rtl.css 265 B
build/reusable-blocks/style.css 265 B
build/rich-text/index.min.js 11 kB
build/server-side-render/index.min.js 2.09 kB
build/shortcode/index.min.js 1.52 kB
build/style-engine/index.min.js 1.53 kB
build/token-list/index.min.js 650 B
build/url/index.min.js 3.74 kB
build/vendors/inert-polyfill.min.js 2.48 kB
build/vendors/react-dom.min.js 41.8 kB
build/vendors/react.min.js 4.02 kB
build/viewport/index.min.js 1.09 kB
build/warning/index.min.js 280 B
build/widgets/index.min.js 7.3 kB
build/widgets/style-rtl.css 1.18 kB
build/widgets/style.css 1.18 kB
build/wordcount/index.min.js 1.06 kB

compressed-size-action

@jameskoster
Copy link
Contributor

I know we won't get there for 6.2, but it would be sweet if you could reset customisations in this panel.

Screenshot 2023-03-03 at 15 22 13

On that note, should we still mark customised template parts somehow? The management view does this:

Screenshot 2023-03-03 at 15 22 49

Maybe we can add a similar suffix here? "Added by Twenty Twenty-Three (customized)".

Question: Do we also want to display the icon as in the template parts list view?

I don't think it's essential for 6.2. We need to do a little design exploration on how best to organise things there. Icons might be the solution, but we can also try splitting the list into sections, or even having dedicated panels for each semantic area.

@kevin940726
Copy link
Member Author

should we still mark customised template parts somehow?

I can take it for a spin!

I don't think it's essential for 6.2. We need to do a little design exploration on how best to organise things there.

Sure thing! Sounds good to me.

@kevin940726
Copy link
Member Author

should we still mark customised template parts somehow

Done in 7680c6c.

image

@github-actions
Copy link

github-actions bot commented Mar 6, 2023

Flaky tests detected in c7b831f.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4411432295
📝 Reported issues:

Copy link
Contributor

@jameskoster jameskoster 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 as expected for me.

Question: Do we also want to display the icon as in the template parts list view?

Going back to this point, it might be worth adding some descriptive text based on the semantic areas. But I think we can do so in a separate issue.

@kevin940726 kevin940726 force-pushed the add/template-description-in-navigation-sidebar branch from 7680c6c to 00f13ee Compare March 7, 2023 03:59
Copy link
Contributor

@talldan talldan left a comment

Choose a reason for hiding this comment

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

It's nice to see this tidied up, good work!

packages/edit-site/src/components/list/added-by.js Outdated Show resolved Hide resolved
packages/edit-site/src/components/list/added-by.js Outdated Show resolved Hide resolved
packages/edit-site/src/components/list/added-by.js Outdated Show resolved Hide resolved
@talldan talldan requested a review from youknowriad March 7, 2023 05:16
@kevin940726
Copy link
Member Author

Seems like this has some overlaps with #48739. We have a few options:

  1. Only show the description in Update: Add descriptions to all panels in the Site Editor's dark side #48739
    image

  2. Only show the added by text for template parts
    image

  3. Show both
    image

Which do we want to move forward to?

@talldan
Copy link
Contributor

talldan commented Mar 7, 2023

Both could be visible, but it might need a bit of design magic. ✨

@talldan talldan added the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Mar 7, 2023
@kevin940726
Copy link
Member Author

I'll go with both for now. Welcome to do any design tweaks on this!

@Mamaduka Mamaduka added the Needs Design Feedback Needs general design feedback. label Mar 7, 2023
@Mamaduka
Copy link
Member

Mamaduka commented Mar 7, 2023

Thank you, @kevin940726!

I'll try to cherry-pick this for Beta 5 based on design feedback.

@jameskoster
Copy link
Contributor

It's probably fine to have both, though "This is your Footer template part" is not super useful. Maybe we concatenate?

This is your Footer template part, added by Twenty Twenty-Three.

For the description I'd rather push towards something like #48777, but suspect we don't have time.

@jameskoster
Copy link
Contributor

After a quick chat with Matias:

  • There's not so much value in listing the theme author since that is kind of the default
  • "Added by" wording isn't great and probably not necessary
  • For plugins it would be great if we can use a brand element.

A revised design:

Screenshot 2023-03-07 at 16 51 46

The icon comes from the block category supplied by the plugin. We can fallback to the generic plugin icon when necessary. For custom templates we can display the username + Gravatar.

@kevin940726
Copy link
Member Author

Here's what it looks like for theme-added customized template parts.

image

And for user:

image

@kevin940726
Copy link
Member Author

Right now it only shows a generic plugin icon. It seems like relying on the block categories' icon is not consistent across plugins, as they are not related to the templates. Any ideas for this? Or we can enhance it in a follow-up.

image

- increase space between icon / label
- apply rounded corners to gravatar
- colorise fallback icon
@jameskoster
Copy link
Contributor

Thanks for the revisions.

I don't think we need to display this detail for theme-added template parts, since that's kind of the default. It seems more important to indicate when templates are not from the theme, IE plugin or user created.

It seems like relying on the block categories' icon is not consistent across plugins, as they are not related to the templates

How do you mean? I don't think it matters if they're related to templates, it's more of a branding detail that can be used in multiple places. Similar to the Plugin panel in the editor:

Screenshot 2023-03-08 at 11 01 19

The plugin icon is fine as a fallback.


I noticed a small bug, if I customise a plugin template then it switches from plugin-created to user-created:

Screenshot 2023-03-08 at 11 08 22

It should still be marked as a plugin template, but also marked as customized.

@kevin940726
Copy link
Member Author

How do you mean? I don't think it matters if they're related to templates, it's more of a branding detail that can be used in multiple places.

The only info we get from getCategories() right now is title, slug, and icon. Categories themselves don't seem to be related to plugins (there's no plugin field). Moreover, a plugin can register multiple block categories, should we just choose a random one in this case? Maybe there's an API for that I don't know of though!

I noticed a small bug, if I customise a plugin template then it switches from plugin-created to user-created

It should already be how it behaves in trunk in the manage template parts view though. Might be worth opening a new issue for that?

@talldan
Copy link
Contributor

talldan commented Mar 9, 2023

The icon that a plugin adds for a block category might not be anything like the plugin's logo or branding. It could be a really plain 'category' icon, and it would be look like a bug to use that to represent the plugin.

The block category icon was never pitched as a way for a plugin to add its branding, it just happens to be what WooCommerce does in that example.

@Mamaduka
Copy link
Member

Mamaduka commented Mar 9, 2023

@kevin940726, @jameskoster, may I suggest punting this for WP 6.3? Sorry, I forgot that beta 5 already had a soft string freeze.

@kevin940726
Copy link
Member Author

Fine with me 👍

@Mamaduka Mamaduka removed the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Mar 9, 2023
@jameskoster
Copy link
Contributor

Thanks for clarifying. I guess we'll have to run with the default plugin icon to begin with, but we should explore a way for plugins to supply a branding element (probably icon + color), it will be important as we move into phase 3.

It should already be how it behaves in trunk in the manage template parts view though. Might be worth opening a new issue for that?

That's not how it behaves on trunk. Here's what I see on the template management view:

Screenshot 2023-03-09 at 10 03 55

@kevin940726
Copy link
Member Author

That's not how it behaves on trunk. Here's what I see on the template management view

Interesting! Looks like if you go to the manage templates view, then go back to single template view, it will show "plugin (customized)". But as soon as editing the template, it will show the author's name instead. I'm not sure what went wrong, because it's using the exact same code as in the management template view. When will has_theme_file change? Anyway, I don't think it is related to this PR, but this PR does make it more visible though.

@jameskoster
Copy link
Contributor

Do you think we should fix that (separately) before merging this? The inconsistency seems a bit awkward to me.

@kevin940726
Copy link
Member Author

Do you think we should fix that (separately) before merging this?

Yeah, I think so, cuz I'm not sure how to fix it. Unless someone can point me in a direction of a quick fix? Maybe it's still better to separate it into a different PR so that discussions don't diverge there.

@jameskoster
Copy link
Contributor

Separate PR sounds good 👍

Since this is no longer on the table for 6.2, I don't think it necessarily needs to be blocked.

@jameskoster
Copy link
Contributor

The last thing to do here is remove the "added by" detail when the template was supplied by the active theme.

@kevin940726
Copy link
Member Author

@jameskoster Not sure if I understand it correctly. I just pushed a commit to hide the "added by" detail if the template is added by a theme and the theme is the currently active theme.

Copy link
Contributor

@jameskoster jameskoster left a comment

Choose a reason for hiding this comment

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

Thanks @kevin940726 ! I think this is working well. We can address the issue around plugin templates being marked as custom separately.

@kevin940726 kevin940726 merged commit 213bc3f into trunk Mar 15, 2023
@kevin940726 kevin940726 deleted the add/template-description-in-navigation-sidebar branch March 15, 2023 02:58
@github-actions github-actions bot added this to the Gutenberg 15.4 milestone Mar 15, 2023
@femkreations femkreations added the Needs User Documentation Needs new user documentation label Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") Needs Design Feedback Needs general design feedback. Needs User Documentation Needs new user documentation
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Expanding the contents of the details panel when viewing a template part
7 participants