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

Template part - register block variations and area selection inputs from original area definitions. #30821

Conversation

Addison-Stavlo
Copy link
Contributor

@Addison-Stavlo Addison-Stavlo commented Apr 13, 2021

Description

This PR updates the Template Part block's variations, area selection inputs, and default wrapper elements to be based off the areas defined in template-parts.php and passed into the editor store via settings. This allows these block variations and corresponding selection interfaces throughout the editors to share a single source of truth for the valid areas, their labels, descriptions, etc. Once a new area is defined in template-parts.php (or by the related filter), the corresponding block variation and selection options will automatically be present in the editor.

How has this been tested?

Smoke test the Template parts block variations in the post/page editor and the site editor, verify they continue to work as expected and that the expected wrapper element appears in both the editor and front-end.

Extra Credit Testing:

Add a new area variation and verify it appears and functions as expected throughout the editor. This can either be added directly to the $default_area_definitions in template-parts.php, or via the default_wp_template_part_areas filter (for simplicity this can be done in template-parts.php above the corresponding apply_filters call). Example:

function register_my_new_area( $areas ) {
	array_push(
		$areas,
		array(
			'area'                  => 'example',
			'label'                 => __( 'Some Example', 'gutenberg' ),
			'description'           => __(
				'Its a description of an example!'
			),
			'icon'                  => 'audio',
			'area_tag'           => 'article',
		)
	);
	return $areas;
}
add_filter( 'default_wp_template_part_areas', 'register_my_new_area' );

Load the editor and verify the new block variation is registered in the inserter and placeholder flow:

Screen Shot 2021-04-14 at 2 36 07 PM

Screen Shot 2021-04-14 at 2 36 59 PM

That the corresponding icons and description appear for a template part using that variation:

Screen Shot 2021-04-14 at 2 38 15 PM

That it appears as an option in the 'area' selection in the block inspector:

Screen Shot 2021-04-14 at 2 41 28 PM

That the 'convert to template part' flow from the block toolbar's ellipsis menu (site editor only) contains the new variation as an option:

Screen Shot 2021-04-14 at 2 44 25 PM

And that the new template part uses its specified defaultWrapperElement (both in editor and on front-end) and that it appears as the default in the block inspector selection:

Screen Shot 2021-04-14 at 3 36 54 PM
Screen Shot 2021-04-14 at 3 37 11 PM
Screen Shot 2021-04-14 at 4 01 07 PM

Types of changes

Refactor existing functionality for truth consolidation and extensibility.

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).

@Addison-Stavlo Addison-Stavlo self-assigned this Apr 13, 2021
@Addison-Stavlo Addison-Stavlo changed the title Template part - try registering variations from store settings. Template part - try registering variations from area definitons Apr 13, 2021
@github-actions
Copy link

github-actions bot commented Apr 13, 2021

Size Change: +60.9 kB (+4%)

Total Size: 1.49 MB

Filename Size Change
build/annotations/index.js 3.78 kB -8 B (0%)
build/api-fetch/index.js 3.42 kB +2 B (0%)
build/autop/index.js 2.83 kB +8 B (0%)
build/block-directory/index.js 8.6 kB -28 B (0%)
build/block-editor/index.js 131 kB +3.1 kB (+2%)
build/block-editor/style-rtl.css 13.1 kB +588 B (+5%) 🔍
build/block-editor/style.css 13.1 kB +581 B (+5%) 🔍
build/block-library/blocks/file/editor-rtl.css 301 B +126 B (+72%) 🆘
build/block-library/blocks/file/editor.css 300 B +126 B (+72%) 🆘
build/block-library/blocks/file/style-rtl.css 255 B +7 B (+3%)
build/block-library/blocks/file/style.css 255 B +7 B (+3%)
build/block-library/blocks/navigation/editor-rtl.css 1.24 kB +3 B (0%)
build/block-library/blocks/navigation/editor.css 1.24 kB +3 B (0%)
build/block-library/blocks/navigation/style-rtl.css 272 B +68 B (+33%) 🚨
build/block-library/blocks/navigation/style.css 271 B +66 B (+32%) 🚨
build/block-library/blocks/query/editor-rtl.css 131 B -679 B (-84%) 🏆
build/block-library/blocks/query/editor.css 132 B -677 B (-84%) 🏆
build/block-library/blocks/site-logo/editor-rtl.css 440 B +2 B (0%)
build/block-library/blocks/site-logo/editor.css 441 B +3 B (+1%)
build/block-library/blocks/site-logo/style-rtl.css 154 B +4 B (+3%)
build/block-library/blocks/site-logo/style.css 154 B +4 B (+3%)
build/block-library/blocks/video/editor-rtl.css 568 B +64 B (+13%) ⚠️
build/block-library/blocks/video/editor.css 569 B +66 B (+13%) ⚠️
build/block-library/editor-rtl.css 9.47 kB -298 B (-3%)
build/block-library/editor.css 9.46 kB -300 B (-3%)
build/block-library/index.js 151 kB -1.67 kB (-1%)
build/block-library/style-rtl.css 9.44 kB +44 B (0%)
build/block-library/style.css 9.44 kB +46 B (0%)
build/block-serialization-default-parser/index.js 1.87 kB +3 B (0%)
build/blocks/index.js 48.6 kB +42 B (0%)
build/components/index.js 287 kB +1.63 kB (+1%)
build/components/style-rtl.css 16.3 kB +1 B (0%)
build/components/style.css 16.3 kB +2 B (0%)
build/compose/index.js 11.6 kB +336 B (+3%)
build/core-data/index.js 17 kB -117 B (-1%)
build/customize-widgets/index.js 8.27 kB +1.17 kB (+17%) ⚠️
build/customize-widgets/style-rtl.css 666 B +36 B (+6%) 🔍
build/customize-widgets/style.css 667 B +36 B (+6%) 🔍
build/data-controls/index.js 839 B +1 B (0%)
build/data/index.js 9.19 kB +313 B (+4%)
build/date/index.js 31.8 kB -24 B (0%)
build/dom/index.js 5.13 kB -126 B (-2%)
build/edit-navigation/index.js 17 kB +41 B (0%)
build/edit-navigation/style-rtl.css 2.86 kB +4 B (0%)
build/edit-navigation/style.css 2.86 kB +4 B (0%)
build/edit-post/index.js 339 kB +31.8 kB (+10%) ⚠️
build/edit-post/style-rtl.css 6.96 kB -17 B (0%)
build/edit-post/style.css 6.95 kB -19 B (0%)
build/edit-site/index.js 28.9 kB +584 B (+2%)
build/edit-widgets/index.js 16.6 kB +924 B (+6%) 🔍
build/editor/index.js 65.5 kB +23 kB (+54%) 🆘
build/editor/style-rtl.css 3.9 kB -20 B (-1%)
build/editor/style.css 3.9 kB -21 B (-1%)
build/element/index.js 4.61 kB -8 B (0%)
build/format-library/index.js 6.77 kB +12 B (0%)
build/html-entities/index.js 623 B +1 B (0%)
build/i18n/index.js 4.04 kB -4 B (0%)
build/is-shallow-equal/index.js 698 B -1 B (0%)
build/keyboard-shortcuts/index.js 2.54 kB +3 B (0%)
build/keycodes/index.js 1.95 kB -5 B (0%)
build/list-reusable-blocks/index.js 3.19 kB -8 B (0%)
build/media-utils/index.js 5.39 kB +6 B (0%)
build/notices/index.js 1.85 kB -3 B (0%)
build/nux/index.js 3.42 kB -1 B (0%)
build/plugins/index.js 2.96 kB +9 B (0%)
build/primitives/index.js 1.42 kB -6 B (0%)
build/react-i18n/index.js 1.45 kB -2 B (0%)
build/redux-routine/index.js 2.84 kB -3 B (0%)
build/reusable-blocks/index.js 3.82 kB +32 B (+1%)
build/rich-text/index.js 13.5 kB +20 B (0%)
build/token-list/index.js 1.27 kB -1 B (0%)
build/url/index.js 3.02 kB -7 B (0%)
build/viewport/index.js 1.85 kB -4 B (0%)
build/warning/index.js 1.14 kB +1 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 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 503 B 0 B
build/block-library/blocks/button/style.css 503 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 436 B 0 B
build/block-library/blocks/columns/style.css 435 B 0 B
build/block-library/blocks/cover/editor-rtl.css 605 B 0 B
build/block-library/blocks/cover/editor.css 605 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.23 kB 0 B
build/block-library/blocks/cover/style.css 1.23 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/frontend.js 765 B 0 B
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB 0 B
build/block-library/blocks/freeform/editor.css 2.44 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.09 kB 0 B
build/block-library/blocks/gallery/style.css 1.09 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 398 B 0 B
build/block-library/blocks/legacy-widget/editor.css 399 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-link/editor-rtl.css 597 B 0 B
build/block-library/blocks/navigation-link/editor.css 597 B 0 B
build/block-library/blocks/navigation-link/style-rtl.css 1.07 kB 0 B
build/block-library/blocks/navigation-link/style.css 1.07 kB 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-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-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-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/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/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/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 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/template-part/editor-rtl.css 552 B 0 B
build/block-library/blocks/template-part/editor.css 551 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/style-rtl.css 173 B 0 B
build/block-library/blocks/video/style.css 173 B 0 B
build/block-library/common-rtl.css 1.31 kB 0 B
build/block-library/common.css 1.31 kB 0 B
build/block-library/reset-rtl.css 502 B 0 B
build/block-library/reset.css 503 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/deprecated/index.js 787 B 0 B
build/dom-ready/index.js 577 B 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 0 B
build/edit-site/style-rtl.css 4.9 kB 0 B
build/edit-site/style.css 4.89 kB 0 B
build/edit-widgets/style-rtl.css 2.97 kB 0 B
build/edit-widgets/style.css 2.98 kB 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/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 731 B 0 B
build/nux/style.css 727 B 0 B
build/priority-queue/index.js 790 B 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/server-side-render/index.js 2.6 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

@Addison-Stavlo Addison-Stavlo changed the title Template part - try registering variations from area definitons Template part - register block variations and area selection inputs from original area definitions. Apr 14, 2021
@david-szabo97
Copy link
Member

One thing I've noticed is, wrapper element seems to be defaulting to div until I click on New Template Part:
image

I inserted a Some Example block from your testing instructions, so I would expect article here. This happens for all the template part variations.

Copy link
Contributor

@ntsekouras ntsekouras 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 @Addison-Stavlo!

@Addison-Stavlo
Copy link
Contributor Author

I inserted a Some Example block from your testing instructions, so I would expect article here. This happens for all the template part variations.

@david-szabo97 good catch! That should be fixed now.

Copy link
Member

@david-szabo97 david-szabo97 left a comment

Choose a reason for hiding this comment

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

LGTM! 🚢

Copy link
Contributor

@ntsekouras ntsekouras 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 Addison! 👍

packages/editor/src/store/utils/get-template-part-icon.js Outdated Show resolved Hide resolved
@Addison-Stavlo Addison-Stavlo merged commit e5b0a86 into trunk Apr 23, 2021
@Addison-Stavlo Addison-Stavlo deleted the try/template-part-block-variations-from-filtered-definitions branch April 23, 2021 13:36
@github-actions github-actions bot added this to the Gutenberg 10.6 milestone Apr 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Template Part Affects the Template Parts Block
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants