Composite: stabilize APIs #63569
Merged
Composite: stabilize APIs #63569
+60
−143
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
3 tasks
This was referenced Jul 15, 2024
ciampo
force-pushed
the
feat/stabilize-composite/swap-from-private-to-public
branch
2 times, most recently
from
60b37e1
to
f11a295
Compare
ciampo
commented
Aug 9, 2024
|
Size Change: -424 B (-0.02%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
ciampo
commented
Aug 9, 2024
packages/dataviews/src/components/dataviews-filters/search-widget.tsx
Outdated
Show resolved
Hide resolved
|
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. |
oandregal
reviewed
Aug 12, 2024
ciampo
commented
Aug 12, 2024
tyxla
approved these changes
Aug 12, 2024
Comment on lines
25
to
29
| CompositeV2: Composite, | ||
| CompositeGroupV2: Composite.Group, | ||
| CompositeItemV2: Composite.Item, | ||
| CompositeRowV2: Composite.Row, | ||
| useCompositeStoreV2: useCompositeStore, |
There was a problem hiding this comment.
Glad to see @wordpress/components private APIs are down with over 25% 👏
packages/dataviews/src/components/dataviews-filters/search-widget.tsx
Outdated
Show resolved
Hide resolved
tyxla
reviewed
Aug 12, 2024
packages/dataviews/src/components/dataviews-filters/search-widget.tsx
Outdated
Show resolved
Hide resolved
Thank you! I'd like to get clarity both on the
I'm also considering opening a separate PR with the changes to |
|
#64450 looks good 👍 Let's merge it, and this one will be much smaller. I'm happy to re-review once it's ready. |
ciampo
force-pushed
the
feat/stabilize-composite/swap-from-private-to-public
branch
2 times, most recently
from
d730894
to
243707b
Compare
|
Update: with #64493 merged, this PR should be good to be merged too. I'll wait for CI, run some extra manual tests, and merge if everything looks good. |
|
Flaky tests detected in aa04cef. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10389181373
|
ciampo
added
the
[Status] Blocked
ciampo
force-pushed
the
feat/stabilize-composite/swap-from-private-to-public
branch
from
aa04cef
to
c82a92d
Compare
ciampo
removed
the
[Status] Blocked
ciampo
changed the title
|
@WordPress/gutenberg-components This PR is now ready for a new round of review, after addressing all the necessary API changes in #64723 & related. |
ciampo
added
the
Needs Dev Note
tyxla
approved these changes
Sep 5, 2024
Comment on lines
-16
to
-21
| CompositeV2: Composite, | ||
| CompositeGroupV2: Composite.Group, | ||
| CompositeItemV2: Composite.Item, | ||
| CompositeRowV2: Composite.Row, | ||
| CompositeTypeaheadV2: Composite.Typeahead, | ||
| CompositeHoverV2: Composite.Hover, |
There was a problem hiding this comment.
So cool to see @wordpress/components private APIs going down by half 👏
ciampo
deleted the
feat/stabilize-composite/swap-from-private-to-public
branch
ciampo
added
has 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.
What?
Requires #63564, #64399, #64397, #64450, #64493 and #64723
Part of #58850
Export
Compositeas a stable API and refactor usages of the component from using the private APIs to using the public ones..Also, remove the private APIs since the component is now public.
Why?
This is one of the final steps in making the
Compositecomponent stable and available as a public API of@wordpress/components.How?
Main changes
Compositecomponent from the@wordpress/componentspackage as stable APIsTesting Instructions
Given that the project builds and tests pass, most of the changes don't really need testing, since the underlying composite components are the exact same (we only changed the way they are imported).
The only real testing that should be done is around the changes where the unnecessary
storeandonFocusVisibleprops were removed.✍️ Dev note
A new stable
CompositecomponentFollowing the rewrite of the
__unstableComposite(& related) components fromariakittoreakitin the WordPress 6.5 release, the 6.7 release introduces a new, stable version for theCompositecomponent.The new
Compositecomponent offers a more complete and versatile way to implement low-level composite widgets, and its APIs are more consistent with the rest of the@wordpress/componentspackage.For more information of the component's APIs and other usage examples, please refer to the Storybook page.
Finally, the
__unstableComposite(& related) components have been marked as deprecated.