Deprecate DimensionControl
#64951
Merged
Deprecate DimensionControl
#64951
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
mirka
added
[Type] Code Quality
This was referenced Aug 30, 2024
mirka
commented
Aug 30, 2024
Comment on lines
-30
to
-32
| import { | ||
| DimensionControl, | ||
| } from '@wordpress/components'; |
There was a problem hiding this comment.
This ResponsiveBlockControl component itself is also obsolete, but updating the example in this readme anyway.
Here is a story if you want to see what this component does:
/**
* WordPress dependencies
*/
import { useState } from '@wordpress/element';
/**
* Internal dependencies
*/
import ResponsiveBlockControl from '../';
export default {
title: 'BlockEditor/ResponsiveBlockControl',
component: ResponsiveBlockControl,
};
export const Default = () => {
const [ isResponsive, setIsResponsive ] = useState( false );
return (
<ResponsiveBlockControl
title="Padding"
property="padding"
isResponsive={ isResponsive }
onIsResponsiveChange={ () => {
setIsResponsive( ! isResponsive );
} }
renderDefaultControl={ ( labelComponent, viewport ) => {
return (
<>
<label htmlFor={ viewport.id }>
{ labelComponent }
</label>
<input type="number" id={ viewport.id } />
</>
);
} }
/>
);
};| @@ -1,5 +1,9 @@ | |||
| # DimensionControl | |||
|
|
|||
| <div class="callout callout-alert"> | |||
| This component is deprecated. | |||
There was a problem hiding this comment.
I'm refraining from issuing any "Use ___ instead" guidance, because nobody uses this anyway (also I don't know 😇).
There was a problem hiding this comment.
At most we could say "Use SelectControl or CustomSelectControl with and pass this set of options"
There was a problem hiding this comment.
Given that the original code example is for padding, I'm guessing most extenders would just use a Dimensions hook now. Doesn't cover the responsive case though 😕
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +11 B (0%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 44142aa. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10639001609
|
ciampo
reviewed
Aug 31, 2024
| @@ -3,6 +3,7 @@ | |||
| const PREVIOUSLY_EXPERIMENTAL_COMPONENTS = [ | |||
| 'alignmentmatrixcontrol', | |||
| 'customselectcontrol-v2', | |||
| 'dimensioncontrol', | |||
There was a problem hiding this comment.
Is this redirect going to work? Usually we change from "experimental" to "stable", but in this instance we're changing to "deprecated" — would this affect the new URL?
There was a problem hiding this comment.
Unless I misunderstand, this is unnecessary.
There was a problem hiding this comment.
Good question. For the components moved to the Deprecated section, we're explicitly setting an id in the story meta so it won't include the word "deprecated" in the URL.
tyxla
approved these changes
Sep 2, 2024
There was a problem hiding this comment.
LGTM 👍
Should we also remove it from the documentation:
Lines 824 to 829 in ade27ac
I wasn't sure about it, since I don't see any deprecated components being ignored from docs, but then, we also don't have many hard-deprecated components:
gutenberg/docs/tool/manifest.js
Lines 14 to 21 in 4119044
I think we are obligated to keep it around until we actually delete the export from the package. |
97 tasks
ciampo
added
the
has dev note
ciampo
removed
the
Needs Dev Note
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.
Part of #59418
What?
Deprecates the
DimensionControlcomponent, scheduled to be hard removed in WP 7.0.Why?
There is virtually no usage of this component, neither in Gutenberg nor the ecosystem.
✍️ Dev note
The
DimensionControlcomponent is now marked as deprecated and scheduled for removal in the WordPress 7.0 release.Usages of
DimensionControlcan be replaced withSelectControlandCustomSelectControl, passing an array of dimension options to the components.