Move `duplicateTemplatePart` action to the `@wordpress/fields` package #65390

gigitux · 2024-09-17T08:05:08Z

What?

This PR migrates the duplicateTemplatePart action to the @wordpress/fields package. The primary issue with this action is its dependency on the CreateTemplatePartModalContents component, which resides in the @wordpress/editor package. Due to this, it can't be directly used within the @wordpress/fields package.

For the purpose of the @wordpress/fields package work, I have temporarily moved the component to this package. However, I'm not certain if this is the best long-term solution. Ideally, this component (and potentially others) should reside in a dedicated package, such as @wordpress/template, which would be more appropriate for components related to template and template-parts. A similar package for the patterns already exists: https://github.com/WordPress/gutenberg/blob/d6fcf4aea4aff17cf0910862bf10090e20ba2ab0/packages/patterns/src

Please review and provide feedback on whether this approach is suitable or if there are alternative recommendations for handling these dependencies. Thanks! 🙏 cc @youknowriad @oandregal

Testing Instructions

Ensure that Custom Dataviews is enabled.

Visit the Site Editor.
Visit the patterns view.
Click on header
Duplicate a header template part.
Ensure that the duplicated template part is created.

Testing Instructions for Keyboard

Screenshots or screencast

…n-dataviews

…n-dataviews-2

gigitux · 2024-09-17T08:05:58Z

packages/fields/src/components/create-template-part-modal/index.tsx

@@ -152,10 +208,14 @@ export function CreateTemplatePartModalContents( {
 						label={ __( 'Area' ) }
 						className="editor-create-template-part-modal__area-radio-group"


Should I update these classes even if it is a temporary solution?

Yeah I think we should update them ideally fields instead of editor basically.

I updated it with 199c313

github-actions · 2024-10-24T08:04:31Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: gigitux <[email protected]>
Co-authored-by: youknowriad <[email protected]>
Co-authored-by: oandregal <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

youknowriad · 2024-10-24T10:20:09Z

packages/editor/src/components/template-part-menu-items/convert-to-template-part.js

@@ -13,7 +13,7 @@ import { symbolFilled } from '@wordpress/icons';
 /**
 * Internal dependencies
 */
-import CreateTemplatePartModal from '../create-template-part-modal';
+import { CreateTemplatePartModal } from '@wordpress/fields';


Yes, I agree this is weird, but also not sure what's the best place for these wp-core-data aware components. That said I can live with it being in fields for now.

Maybe we should add a comment explaining the choice.

With 47da440 I added some documentation.

youknowriad · 2024-10-24T10:22:18Z

packages/fields/src/constants.ts

+	plugin: 'plugin',
+};
+
+export const TEMPLATE_PART_AREA_DEFAULT_CATEGORY = 'uncategorized';


Personally I hate these constants file and would rather mostly remove them (especially since most of these types are "typed" now.

Removed with 64423cf

youknowriad · 2024-10-24T10:33:07Z

packages/fields/src/components/create-template-part-modal/index.tsx

 		[]
 	);
+
+	const defaultTemplatePartAreas = getDefaultTemplatePartAreas( settings );


Personally, I think this is the wrong solution to retrieving the default template areas. There might not be a rendered block-editor when using the fields, so I don't think a dependency to "block-editor" is the right approach.

The main issue here is that defaultTemplateTypes and defaultTemplatePartAreas are passed from the server to the client through the editor settings initialization. I think this is the wrong approach. The right approach would be to move these to getEntityRecord( 'root', '__unstableBase' ) endpoint and add them in the server to this endpoint. I believe we did things like that in the past for things like site_icon_url ... Do you think this is something we can try in its own PR. I'm a bit concerned that the current field won't work as expected in all contexts.

Do you think this is something we can try in its own PR. I'm a bit concerned that the current field won't work as expected in all contexts.

I'm happy to work on it with a dedicated PR! 💪

I created #66459. Let me know if you agree with the approach that I took!

…n-dataviews-3

gigitux · 2024-11-26T10:57:22Z

This PR is ready to be reviewed! cc @oandregal @youknowriad @louwie17

…n-dataviews-3

youknowriad · 2024-11-29T08:43:42Z

packages/fields/README.md

+-   _props.closeModal_ `Function`: - Function to close the modal.
+-   _props.onCreate_ `Function`: - Function to call when the template part is successfully created.
+-   _props.onError_ `[Function]`: - Function to call when there is an error creating the template part.
+-   _props.defaultTitle_ `[string]`: - The default title for the template part.


Do we need both components to be exposed?

Fixed with 4583cf8

youknowriad · 2024-11-29T08:43:57Z

packages/fields/README.md

@@ -42,6 +66,14 @@ Undocumented declaration.

 Undocumented declaration.

+### duplicateTemplatePart


Do we need this to be a public API here?

Are we using it elsewhere?

We are using only here. I'm happy to make a “private” API.

youknowriad · 2024-11-29T08:47:37Z

packages/fields/package.json

@@ -35,6 +35,7 @@
 		"@babel/runtime": "7.25.7",
 		"@wordpress/api-fetch": "*",
 		"@wordpress/blob": "*",
+		"@wordpress/block-editor": "*",


Why is this needed?

Fixed with e0f518e.

…n-dataviews-3

… into add/action-dataviews-3

gigitux added 26 commits September 12, 2024 09:33

Migrate store and actions from editor package to fields package

67ff043

fix documentation

a71e726

fix import

0141d8c

remove duplicate code

f21a974

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

7063ee8

…n-dataviews

update package-lock

644dab1

refactor PR

3616964

fix mobile build

f7f1d4d

update package.json

ae0efeb

migrate actions to @wordpress/fields package

4356a42

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

bf1462a

…n-dataviews-2

reduce change

63adf35

register new action

c938a15

improve code

66479da

fix actionId

0bf760d

update package-lock.json

08bb03d

remove comment

b599c42

rename function

337b3e5

rename functions

1016ef8

improve code

39d25d1

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

dc03f57

…n-dataviews-2

Migrate duplicate-template-part action to @wordpress/fields package

599c0a4

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

60e7a58

…n-dataviews-2

fix build

81c0980

restore files

7b2bb82

fix CSS

d6fcf4a

gigitux commented Sep 17, 2024

View reviewed changes

gigitux added 3 commits September 18, 2024 11:15

restore delete post action

0316536

fix import order

485237f

move to a flat structure

5a4fb59

gigitux marked this pull request as ready for review October 24, 2024 08:04

regenerate package-lock.json file

36adb07

youknowriad reviewed Oct 24, 2024

View reviewed changes

gigitux added 4 commits October 24, 2024 14:59

generate documentation

47da440

delete constant file

64423cf

update class

199c313

rename styles.scss to style.scss

8571360

gigitux mentioned this pull request Oct 25, 2024

Move default template types and template part areas to REST API #66459

Merged

gigitux added 3 commits October 28, 2024 12:23

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

844a98a

…n-dataviews-3

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

0bd24a7

…n-dataviews-3

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

00533bd

…n-dataviews-3

gigitux requested review from artemiomorales and ajitbohra as code owners November 26, 2024 10:20

gigitux added 3 commits November 26, 2024 11:48

restore changes

13ea482

fix comment

6dede40

fix comment

63247d0

gigitux requested a review from youknowriad November 26, 2024 10:52

improve documentation

3b6b664

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

8857196

…n-dataviews-3

youknowriad reviewed Nov 29, 2024

View reviewed changes

gigitux mentioned this pull request Nov 29, 2024

Data Views: Add action for pages to set site homepage #65426

Merged

gigitux added 3 commits December 2, 2024 14:36

Merge branch 'trunk' of github.com:WordPress/gutenberg into add/actio…

084383c

…n-dataviews-3

export only CreateTemplatePartModal component

4583cf8

Merge branch 'add/action-dataviews-3' of github.com:gigitux/gutenberg…

02da400

… into add/action-dataviews-3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move `duplicateTemplatePart` action to the `@wordpress/fields` package #65390

Move `duplicateTemplatePart` action to the `@wordpress/fields` package #65390

gigitux commented Sep 17, 2024 •

edited

Loading

gigitux Sep 17, 2024 •

edited

Loading

youknowriad Oct 24, 2024

gigitux Oct 25, 2024

github-actions bot commented Oct 24, 2024 •

edited

Loading

youknowriad Oct 24, 2024

youknowriad Oct 24, 2024

gigitux Oct 24, 2024

youknowriad Oct 24, 2024

gigitux Oct 24, 2024

youknowriad Oct 24, 2024

gigitux Oct 24, 2024

gigitux Oct 25, 2024

gigitux commented Nov 26, 2024

youknowriad Nov 29, 2024

gigitux Dec 2, 2024

youknowriad Nov 29, 2024

youknowriad Nov 29, 2024

gigitux Dec 2, 2024

youknowriad Nov 29, 2024

gigitux Dec 2, 2024

		@@ -152,10 +208,14 @@ export function CreateTemplatePartModalContents( {
		label={ __( 'Area' ) }
		className="editor-create-template-part-modal__area-radio-group"

		@@ -42,6 +66,14 @@ Undocumented declaration.

		Undocumented declaration.

		### duplicateTemplatePart

Move duplicateTemplatePart action to the @wordpress/fields package #65390

Are you sure you want to change the base?

Move duplicateTemplatePart action to the @wordpress/fields package #65390

Conversation

gigitux commented Sep 17, 2024 • edited Loading

What?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

gigitux Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gigitux commented Nov 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Move `duplicateTemplatePart` action to the `@wordpress/fields` package #65390

Move `duplicateTemplatePart` action to the `@wordpress/fields` package #65390

gigitux commented Sep 17, 2024 •

edited

Loading

gigitux Sep 17, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading