Rich text: log deprecation message for multiline prop #43613
Merged
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
ellatrix
added
[Feature] Rich Text
|
Size Change: +97 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
mcsf
reviewed
Aug 25, 2022
| @@ -115,6 +115,14 @@ function RichTextWrapper( | |||
| }, | |||
| forwardedRef | |||
| ) { | |||
| if ( multiline ) { | |||
| deprecated( 'wp.blockEditor.RichText multiline prop', { | |||
| since: '14.1', | |||
There was a problem hiding this comment.
Searching through the codebase, I'd say the convention is to use WP versions here. The only two instances of Gutenberg version numbers (12.6 and 12.7) are in deprecated calls with the accompanying plugin: 'Gutenberg' option.
There was a problem hiding this comment.
Oh. Adjusted it to use WP version numbers and added a version prop.
mcsf
reviewed
Aug 25, 2022
| if ( multiline ) { | ||
| deprecated( 'wp.blockEditor.RichText multiline prop', { | ||
| since: '6.1', | ||
| version: '6.2', |
There was a problem hiding this comment.
I think 6.2 is way too close. Even though everything suggests that the multiline option was minimally used in the ecosystem, it has been part of a stable API for a long time.
For comparison, take the migration of classnames in 5.2 following the introduction of the block editor module. The classes were never even a public API, but we still gave it a year (which was very generous, IMO).
So I think 6.3 should be the absolute minimum.
There was a problem hiding this comment.
Alright :) I think it depends in how much it's communicated, but I agree that a bit longer is probably best.
ntsekouras
reviewed
Aug 26, 2022
ntsekouras
approved these changes
Aug 26, 2022
|
Thank you! |
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.
What?
Deprecates the
multilineprop forRichText. As of #42711, we're no longer using this in core.Why?
Handling multi line content in RichText is quite complex.
createandtoTreefunctions to convert between DOM/HTML and the rich text value.Deprecation would mean that after a WP release we can consider removing this code, which makes rich text easier to maintain and makes refactors easier to do.
For example, #29870 would be much more work if we have to take into account multi line values.
How?
This PR logs a simple message. We'd also have to write a dev not explaining how to change code to InnerBlocks. It's probably also a good idea to have a dedicated message in the email sent to plugin authors every release for extra awareness.
Testing Instructions
Edit a block to using RichText multiline and check the console.
Screenshots or screencast