Update the documentation of the block editor and replace @wordpress/element with react #54908
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
youknowriad
requested review from
ellatrix,
fluiddot,
dcalhoun,
gziolo,
adamsilverstein,
ajitbohra,
ntwb,
nerrad,
ryanwelcher,
noisysocks,
draganescu,
talldan,
tellthemachines,
adamziel,
kevin940726,
ZebulanStanphill,
michalczaplinski,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
youknowriad
added
the
[Type] Developer Documentation
|
Size Change: +506 B (0%) Total Size: 1.62 MB
ℹ️ View Unchanged
|
kevin940726
reviewed
Sep 28, 2023
tyxla
reviewed
Oct 3, 2023
There was a problem hiding this comment.
This is looking great, thanks @youknowriad!
Left a few suggestions and typo fixes, let me know what you think.
| @@ -18,7 +18,7 @@ Go ahead and create these files using the following snippets: | |||
| **src/index.js:** | |||
|
|
|||
| ```js | |||
| import { render } from '@wordpress/element'; | |||
| import { render } from 'react-dom'; | |||
There was a problem hiding this comment.
Should we update that to reflect that we're now using React 18? Same for all other render() instances.
There was a problem hiding this comment.
There something subtle here is that we should do import { createRoot } from 'react-dom' instead of import { createRoot } from 'react-com/client'.
I think that's not great but it's because of how wp-scripts works at the moment. Basically it transforms react-dom imports to ReactDOM global variable and adds the wp dependency to the php script. And because of React generates the build we use, it works because createRoot is actually ReactDOM.createRoot in that build.
I think that's very confusing but I don't plan on solving that in this PR.
Co-authored-by: Marin Atanasov <8436925+tyxla@users.noreply.github.com>
ellatrix
reviewed
Oct 4, 2023
| @@ -58,8 +58,8 @@ registerBlockType( 'gutenberg-examples/example-02-stylesheets', { | |||
| {% Plain %} | |||
|
|
|||
| ```js | |||
| ( function ( blocks, element, blockEditor ) { | |||
| var el = element.createElement; | |||
| ( function ( blocks, React, blockEditor ) { | |||
There was a problem hiding this comment.
Is uppercase also how the default React scripts adds the window variable?
ellatrix
approved these changes
Oct 4, 2023
lipemat
added a commit
to lipemat/types-js-boilerplate
that referenced
this pull request
Nov 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to #54494
Related to #54074
What?
Since we switched the default pragma, this PR updates our documentation to clarify that plugin developers should use react directly instead of @wordpress/element
I also removed the internal WPComponent and WPElement types for clarity. It impacts a high number of files though.
Testing Instructions
This is mostly a documentation change, so nothing to test.