Add @wordpress/fields package #65230

gigitux · 2024-09-11T08:00:04Z

What?

This PR adds the @wordpress/fields package.

Why?

The @wordpress/fields package introduces a collection of data field controls designed specifically for WordPress UI and needs. For example, this package will include controls for:

Featured Image (#64496)
Slug (#65196)

These field controls provide streamlined and consistent functionality for managing essential WordPress elements.

github-actions · 2024-09-11T08:00:21Z

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]>

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

youknowriad · 2024-09-11T08:51:29Z

packages/fields/src/index.ts

+
+export const privateApis = {};
+
+lock( privateApis, {} );


Instead of locking the APIs, I think we should probably make this package a "bundled one" just like the "dataviews" package itself. I know there are two files (configs) to change to make a package a bundled package tools/webpack/packages.js and packages/dependency-extraction-webpack-plugin/lib/util.js

Addressed with 7e04069

youknowriad · 2024-09-11T08:53:19Z

packages/fields/README.md

@@ -0,0 +1,23 @@
+# Fields
+
+This package includes a set of field controls for the DataView library, designed for creating and managing data display elements within WordPress.


I think it should hold more than just field controls. I believe the whole editor/src/dataviews existing folder belongs in this package.

Fields

Actions

Controls

For WP entities basically.

I improved the package description with 43b8a93:

This package provides core elements for the DataView library, designed to simplify the creation and management of data display elements in WordPress.

Let me know if it can work for you!

youknowriad

I think one of the initial follow-ups to this would be to try to move the fields and actions from packages/editor/src/dataviews/ to this package.

youknowriad · 2024-09-11T08:55:08Z

packages/fields/tsconfig.json

+		{ "path": "../warning" },
+		{ "path": "../url" },
+		{ "path": "../notices" },
+		{ "path": "../dataviews" }


Shouldn't the list above match the dependencies used in the package (empty for now)

Good point! Fixed with b00ec03

youknowriad · 2024-09-11T08:56:33Z

packages/fields/README.md

+
+## Usage
+
+


Should we add the README's API docs autogeneration markers (see other package README's)

Fixed with 6e71a98 and e5fd361

gigitux · 2024-09-11T10:09:15Z

I think one of the initial follow-ups to this would be to try to move the fields and actions from packages/editor/src/dataviews/ to this package.

Yeah! I agree! I will take a look to the packages/editor/src/dataviews/ folder!

youknowriad · 2024-09-11T12:49:22Z

I would be ok approving for the sake of iteration/smaller PRs but can we do at least one PR on top of it to see actual usage of this package in practice?

gigitux · 2024-09-11T13:18:20Z

I would be ok approving for the sake of iteration/smaller PRs but can we do at least one PR on top of it to see actual usage of this package in practice?

It makes sense!

I rebased #65196 on top of this PR. Unfortunately, I can't change the base branch of the linked PR because I'm pushing on my own fork.

Here’s how the slug field control PR looks with this branch as the destination: gigitux#2

This is something that I did to test the benefit of this package. Now, I will follow your suggestion and I'm going move the fields and actions from packages/editor/src/dataviews/ to this package.

youknowriad

Thanks I see that there's a good plan already for the next steps.

gziolo · 2024-09-11T15:28:31Z

Do you plan to publish this package to npm in the current shape with the next Gutenberg plugin RC release next week?

I have one question, the description of the package is:

This package provides core elements for the DataView library, designed to simplify the creation and management of data display elements in WordPress.

Is it tied exclusively to the DataView library? The name @wordpress/fields is very generic, and the term "fields" is quite loaded in the WordPress space: "custom fields" (example article), Fields API project.

gigitux · 2024-09-11T15:47:59Z

Do you plan to publish this package to npm in the current shape with the next Gutenberg plugin RC release next week?

I'm planning to add more code to this package in the next days. Currently, we don't expect that this package will be used by other consumers: I read this documentation and it looks like that there isn't a way to disable the publishing of the package.

Do you see any particular disadvantages to publishing the package?

Is it tied exclusively to the DataView library? The name @wordpress/fields is very generic, and the term "fields" is quite loaded in the WordPress space: "custom fields" (example article), Fields API project.

Yes! I’m still exploring this project, and I wasn’t aware of the Fields API project. After reading the introduction, it seems there is some overlap with the goals of data views, but still, we are in the exploration phase stage.

gziolo · 2024-09-11T15:52:16Z

Do you see any particular disadvantages to publishing the package?

There is no value in publishing a package that isn't functional and can't be consumed. It's a one-line in package.json, like here:

gutenberg/packages/react-native-editor/package.json

Line 11 in 9bfd08f

"private": true,

oandregal · 2024-09-12T09:44:36Z

Do you see any particular disadvantages to publishing the package?

We should not have packages that are unused by core in this repository. Until that happens, I'd rather have it private. Given this has no-reversible consequences (publish to npm) and it's time-sensitive, I've prepared #65269 to mark it as private as Grzegorz suggested.

gigitux · 2024-09-12T09:47:41Z

Do you see any particular disadvantages to publishing the package?

We should not have packages that are unused by core in this repository. Until that happens, I'd rather have it private. Given this has no-reversible consequences (publish to npm) and it's time-sensitive, I've prepared #65269 to mark it as private as Grzegorz suggested.

Ok! Thanks for tacking care of it! 🙇

fabiankaegy · 2024-10-02T19:38:17Z

Hey @gigitux 👋

Would you be able to help write a dev note for this for the 6.7 release? We are planning to have this as part of a larger Miscellaneous Editor Updates note.

We are hoping to get all drafts in by October 13th to leave some time for reviews before the RC1.

All Dev Notes get tracked in #65784 so feel free to leave a note there or ping me directly :)

Please let us know if you can assist with that.

Thanks in advance :)

gigitux · 2024-10-04T15:47:35Z

Thanks for the ping, @fabiankaegy! 🙇

I'm not sure that we should include this in the dev note. Currently, this package is still experimental, we are exploring APIs, and currently I don't think that this package could be useful outside of Gutenberg.

I'm not very expert with this process, so let me include @youknowriad and @oandregal. What do you think? I'm happy to write dev notes if you think that it is needed!

(I'm not sure if with this comment you are referring to this PR)

fabiankaegy · 2024-10-04T16:07:32Z

@gigitux okay, if this package is not bundled with WordPress core as one of the enqueued scripts we don’t need a dev note :)

youknowriad · 2024-10-04T16:29:02Z

The package is not public API yet, so no need for dev note for now indeed.

Add @wordpress/fields package

395cc25

gigitux force-pushed the add/@wordpress-fields branch from 453c13d to 395cc25 Compare September 11, 2024 08:05

gigitux requested review from ajitbohra, juanmaguitar, fabiankaegy and ndiego as code owners September 11, 2024 08:05

youknowriad reviewed Sep 11, 2024

View reviewed changes

gigitux added 4 commits September 11, 2024 11:32

remove not used references

b00ec03

add marker to generate API documentation

6e71a98

improve package description

43b8a93

not use lock/unlock api

7e04069

gigitux requested a review from gziolo as a code owner September 11, 2024 10:05

gigitux requested a review from youknowriad September 11, 2024 10:09

remove apostrophe

e5fd361

gziolo added the [Type] New API New API to be used by plugin developers or package users. label Sep 11, 2024

fix build

9bfd08f

youknowriad approved these changes Sep 11, 2024

View reviewed changes

youknowriad merged commit 0c0e605 into WordPress:trunk Sep 11, 2024
60 checks passed

github-actions bot added this to the Gutenberg 19.3 milestone Sep 11, 2024

gigitux mentioned this pull request Sep 12, 2024

[Fields] Migrate store and actions from editor package to fields package #65261

Merged

oandregal mentioned this pull request Sep 12, 2024

Make wordpress/fields a private package #65269

Merged

noisysocks mentioned this pull request Sep 19, 2024

Revert "Make wordpress/fields a private package" #65477

Merged

fabiankaegy mentioned this pull request Oct 1, 2024

6.7 Dev Note Tracking Issue #65784

Closed

97 tasks

fabiankaegy added the Needs Dev Note Requires a developer note for a major WordPress release cycle label Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add @wordpress/fields package #65230

Add @wordpress/fields package #65230

gigitux commented Sep 11, 2024

github-actions bot commented Sep 11, 2024 •

edited

Loading

youknowriad Sep 11, 2024

gigitux Sep 11, 2024

youknowriad Sep 11, 2024

gigitux Sep 11, 2024

youknowriad left a comment

youknowriad Sep 11, 2024

gigitux Sep 11, 2024

youknowriad Sep 11, 2024

gigitux Sep 11, 2024 •

edited

Loading

gigitux commented Sep 11, 2024

youknowriad commented Sep 11, 2024

gigitux commented Sep 11, 2024 •

edited

Loading

youknowriad left a comment

gziolo commented Sep 11, 2024 •

edited

Loading

gigitux commented Sep 11, 2024

gziolo commented Sep 11, 2024 •

edited

Loading

oandregal commented Sep 12, 2024 •

edited

Loading

gigitux commented Sep 12, 2024

fabiankaegy commented Oct 2, 2024 •

edited

Loading

gigitux commented Oct 4, 2024

fabiankaegy commented Oct 4, 2024

youknowriad commented Oct 4, 2024

		@@ -0,0 +1,23 @@
		# Fields

		This package includes a set of field controls for the DataView library, designed for creating and managing data display elements within WordPress.

Add @wordpress/fields package #65230

Add @wordpress/fields package #65230

Conversation

gigitux commented Sep 11, 2024

What?

Why?

github-actions bot commented Sep 11, 2024 • edited Loading

youknowriad Sep 11, 2024

Choose a reason for hiding this comment

gigitux Sep 11, 2024

Choose a reason for hiding this comment

youknowriad Sep 11, 2024

Choose a reason for hiding this comment

gigitux Sep 11, 2024

Choose a reason for hiding this comment

youknowriad left a comment

Choose a reason for hiding this comment

youknowriad Sep 11, 2024

Choose a reason for hiding this comment

gigitux Sep 11, 2024

Choose a reason for hiding this comment

youknowriad Sep 11, 2024

Choose a reason for hiding this comment

gigitux Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

gigitux commented Sep 11, 2024

youknowriad commented Sep 11, 2024

gigitux commented Sep 11, 2024 • edited Loading

youknowriad left a comment

Choose a reason for hiding this comment

gziolo commented Sep 11, 2024 • edited Loading

gigitux commented Sep 11, 2024

gziolo commented Sep 11, 2024 • edited Loading

oandregal commented Sep 12, 2024 • edited Loading

gigitux commented Sep 12, 2024

fabiankaegy commented Oct 2, 2024 • edited Loading

gigitux commented Oct 4, 2024

fabiankaegy commented Oct 4, 2024

youknowriad commented Oct 4, 2024

github-actions bot commented Sep 11, 2024 •

edited

Loading

gigitux Sep 11, 2024 •

edited

Loading

gigitux commented Sep 11, 2024 •

edited

Loading

gziolo commented Sep 11, 2024 •

edited

Loading

gziolo commented Sep 11, 2024 •

edited

Loading

oandregal commented Sep 12, 2024 •

edited

Loading

fabiankaegy commented Oct 2, 2024 •

edited

Loading