-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Composite: stabilize APIs #63569
Composite: stabilize APIs #63569
Conversation
60b37e1
to
f11a295
Compare
Size Change: -424 B (-0.02%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aside from onFocusVisible
+ focusable
, this looks great to me 👍
Nice work @ciampo 🚀
Let's make sure to add a CHANGELOG entry before 🚢 .
CompositeV2: Composite, | ||
CompositeGroupV2: Composite.Group, | ||
CompositeItemV2: Composite.Item, | ||
CompositeRowV2: Composite.Row, | ||
useCompositeStoreV2: useCompositeStore, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
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. |
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
aa04cef
to
c82a92d
Compare
@WordPress/gutenberg-components This PR is now ready for a new round of review, after addressing all the necessary API changes in #64723 & related. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did some testing in the editor and in Storybook, everything works well!
Let's go! 🚀
Great work addressing it incrementally @ciampo!
CompositeV2: Composite, | ||
CompositeGroupV2: Composite.Group, | ||
CompositeItemV2: Composite.Item, | ||
CompositeRowV2: Composite.Row, | ||
CompositeTypeaheadV2: Composite.Typeahead, | ||
CompositeHoverV2: Composite.Hover, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So cool to see @wordpress/components
private APIs going down by half 👏
What?
Requires #63564, #64399, #64397, #64450, #64493 and #64723
Part of #58850
Export
Composite
as 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
Composite
component stable and available as a public API of@wordpress/components
.How?
Main changes
Composite
component from the@wordpress/components
package 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
store
andonFocusVisible
props were removed.✍️ Dev note
A new stable
Composite
componentFollowing the rewrite of the
__unstableComposite
(& related) components fromariakit
toreakit
in the WordPress 6.5 release, the 6.7 release introduces a new, stable version for theComposite
component.The new
Composite
component 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/components
package.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.