Stabilize LinkControl Component
#56384
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
At the same the this retains the experimental versions of the exported component for better backwards compatibility for the wide usage of the LinkComponent already out there
fabiankaegy
added
[Type] Code Quality
fabiankaegy
requested review from
Mamaduka,
youknowriad,
gziolo and
richtabor
fabiankaegy
requested review from
ellatrix,
fluiddot,
dcalhoun,
getdave,
tellthemachines and
ajitbohra
as code owners
|
Size Change: +121 B (+0.01%) Total Size: 1.83 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 3c1b6a2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6944693938
|
|
I would defer to @getdave and @richtabor on this one. I believe there's still some ongoing work to polish the component. |
|
This component has existed in Gutenberg for a long time as experimental. However in many ways it could be considered a public API because it's been adopted and used by many extenders (as it was available prior to the advent of the private APIs system). The component is still undergoing a round of polish. Once we make this stable changes to the API will be officially disallowed if they break backwards compatibility. On the other hand, this component is already heavily used and thus changes to the API may already be considered "breaking". Also interested to hear Rich's thoughts on this. |
I agree with all of this. My take is that even in the multiple refactors / UI Polishes this component has already seen in the 3 years since it was introduced as So essentially in all but name the component already is stabile in core and has been for the last 3 years. Which is why I created this PR to make that commitment official :) |
39 tasks
|
We should revisit this. This is the control extenders should be using, and having it be experimental leads developers to build their own. What do you think @fabiankaegy @richtabor @getdave? |
|
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. |
|
I've been trying to get this stabilized since September 2021. The API hasn't changed since then and it is widely adopted :) I'm all for releasing it finally. I know @richtabor was against it for a while so I am looking to his guidance :) |
|
I think given it's been around for so long it's pretty much defacto stable anyway. We should formalise that. The last 2 releases saw a lot of UX work going on here so @richtabor and I were reluctant to stablise whilst that was happening. Now we're in a better place I'd be ok to stablise. |
youknowriad
reviewed
Dec 5, 2024
# Conflicts: # packages/block-library/src/button/edit.js # packages/block-library/src/navigation-link/link-ui.js
|
This PR has been updated to only stabilize the |
getdave
approved these changes
Dec 10, 2024
|
I wonder if we should deprecated the experimental exports for the sub components (without exposing them as stable) |
|
@youknowriad done in ae6170a |
|
Thanks :) |
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?
Stabilize the
LinkControlcomponent. (Closing #35073)Why?
Looking at the usage stats there are over 200 plugins in the official Repo already using the component in its current
__experimentalstate. Many of which have a really large user base.Regardless of us continuing to evolve the actual UI of the component, I think it is way past time for us to stabilize the API of the component.
How?
Changes the default export of the component to no longer use the
__experimentalprefix whilst at the same time adding new additional pass-through components that contain a deprecation warning for anyone using the__experimentalversion of the component.Testing Instructions
Ensure the Button Block or adding a link inside a paragraph for example still functions as expected.