Add useEvent and revamped useResizeObserver to @wordpress/compose
#64943
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
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
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. |
DaniGuardiola
added
[Type] Code Quality
|
Needs changelog I guess? What's the protocol for this package? cc @tyxla if you know |
|
Size Change: +133 B (+0.01%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
…eat/add-use-event-and-use-observe-element-size
DaniGuardiola
changed the title
useEvent and useObserveElementSize utilities.useEvent and useObserveElementSize to @wordpress/compose
tyxla
reviewed
Sep 2, 2024
There was a problem hiding this comment.
Thanks for working on those @DaniGuardiola 🙌 useEvent is a very useful one, to start with ⭐
Although I don't think that's a blocker, I'd personally suggest introducing those in separate PRs, as recommended in the contributing docs. For example, we could split them like this:
- Introducing
useEvent() - Introducing
useObserveElementSize - Updating
useResizeObserverto use the above 2.
Furthermore, for each of the new hooks, I'd welcome some tests that can help verify the functionality, but also serve as useful examples of how the hooks are used.
As you already asked, yes, these are new features, so appropriate CHANGELOG entries would make sense.
Last, but not least, I'd love to have some testing instructions. This PR changes useResizeObserver which is used in a few places, and it would be nice to verify we're not breaking anything.
jsnajdr
reviewed
Sep 2, 2024
tyxla
reviewed
Sep 2, 2024
Co-authored-by: Marin Atanasov <8436925+tyxla@users.noreply.github.com>
jsnajdr
reviewed
Sep 10, 2024
There was a problem hiding this comment.
Nice to finally see this merged 🙂 I'm looking forward to trying to replace the current resize observers and getting rid of the helper elements.
I think there is one bug when calling unobserve and a few other minor things.
I'm a bit worried about the React Native use case. Previously React Native had its own index.native.js and it never encountered any browser code with DOM. But now we expose the new resize observer also to RN codebases, and I think it's not going to work there.
DaniGuardiola
changed the title
useEvent and useObserveElementSize to @wordpress/composeuseEvent and revamped useResizeObserver to @wordpress/compose
|
Thanks @jsnajdr, I will open a different PR to address your feedback :) |
Merged
DaniGuardiola
added a commit
that referenced
this pull request
Sep 11, 2024
* Refactor utils and switch Tabs indicator animation to `transform`. * docs tweak * Update packages/components/src/tabs/styles.ts Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> * Add RTL support. * Addressed @ciampo's comments. * Correct for antialiasing rounding. * Make antialiasing adjustment optional. * Use larger base value and revert antialiasing adjustment code. * DRY RTL * Remove RTL story (redundant since Storybook has a dynamic setting to test RTL). * Fix bug. * Fix bug (for real this time). * Add changelog entry. * De-cleverfy code. * Sync useResizeObserver with #64943 and make useTrackElementOffsetRect resilient. * Deduplicate utility and clean up. * DRY antialiasing factor. * Changelogs. --------- Co-authored-by: DaniGuardiola <daniguardiola@git.wordpress.org> Co-authored-by: ciampo <mciampini@git.wordpress.org> Co-authored-by: t-hamano <wildworks@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org>
This was referenced Sep 17, 2024
This was referenced Sep 26, 2024
fabiankaegy
added
the
Needs Dev Note
97 tasks
DaniGuardiola
added a commit
that referenced
this pull request
Oct 1, 2024
* Refactor utils and switch Tabs indicator animation to `transform`. * docs tweak * Update packages/components/src/tabs/styles.ts Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> * Add RTL support. * Addressed @ciampo's comments. * Correct for antialiasing rounding. * Make antialiasing adjustment optional. * Use larger base value and revert antialiasing adjustment code. * DRY RTL * Remove RTL story (redundant since Storybook has a dynamic setting to test RTL). * Fix bug. * Fix bug (for real this time). * Add changelog entry. * De-cleverfy code. * Sync useResizeObserver with #64943 and make useTrackElementOffsetRect resilient. * Deduplicate utility and clean up. * Minor Tabs code improvement. * Replace framer motion animation with faster CSS animation. * DRY antialiasing factor. * Changelogs. * Various improvements, fixes, and feedback addressed. * Simplify. * Simplify using derived state. * Add similar useOnValueUpdate detail to Tabs. * Fix skipping animation. * Add similar detail to Tabs animation. * Fix setState depth issue. * Fix unit test error. * Add changelog entries * Fix changelog * Update test snapshot. * Depends less on React. * Switch to layout effect for `useOnValueUpdate` * Switched to transform strategy. * Fix resizing bug. * Transition border-radius too. * Undo Tabs changes (no longer relevant). * DRY animation code. * Avoid useless re-runs in effect. * Rename `activeElement` -> `selectedElement` for clarity. * Rename `--indicator-` -> `--selected-` for accuracy. * Minor tweak. * Add safe defaults to CSS custom properties. * Tweak `useSubelementAnimation`. * Fix parent missing when there's no selected option. * Update snapshots * Add docs to utility. * Added note about border-radius. --------- Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> Co-authored-by: DaniGuardiola <daniguardiola@git.wordpress.org> Co-authored-by: ciampo <mciampini@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: mirka <0mirka00@git.wordpress.org>
huubl
pushed a commit
to huubl/gutenberg
that referenced
this pull request
Oct 2, 2024
* Refactor utils and switch Tabs indicator animation to `transform`. * docs tweak * Update packages/components/src/tabs/styles.ts Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> * Add RTL support. * Addressed @ciampo's comments. * Correct for antialiasing rounding. * Make antialiasing adjustment optional. * Use larger base value and revert antialiasing adjustment code. * DRY RTL * Remove RTL story (redundant since Storybook has a dynamic setting to test RTL). * Fix bug. * Fix bug (for real this time). * Add changelog entry. * De-cleverfy code. * Sync useResizeObserver with WordPress#64943 and make useTrackElementOffsetRect resilient. * Deduplicate utility and clean up. * Minor Tabs code improvement. * Replace framer motion animation with faster CSS animation. * DRY antialiasing factor. * Changelogs. * Various improvements, fixes, and feedback addressed. * Simplify. * Simplify using derived state. * Add similar useOnValueUpdate detail to Tabs. * Fix skipping animation. * Add similar detail to Tabs animation. * Fix setState depth issue. * Fix unit test error. * Add changelog entries * Fix changelog * Update test snapshot. * Depends less on React. * Switch to layout effect for `useOnValueUpdate` * Switched to transform strategy. * Fix resizing bug. * Transition border-radius too. * Undo Tabs changes (no longer relevant). * DRY animation code. * Avoid useless re-runs in effect. * Rename `activeElement` -> `selectedElement` for clarity. * Rename `--indicator-` -> `--selected-` for accuracy. * Minor tweak. * Add safe defaults to CSS custom properties. * Tweak `useSubelementAnimation`. * Fix parent missing when there's no selected option. * Update snapshots * Add docs to utility. * Added note about border-radius. --------- Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> Co-authored-by: DaniGuardiola <daniguardiola@git.wordpress.org> Co-authored-by: ciampo <mciampini@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: mirka <0mirka00@git.wordpress.org>
|
Hey @DaniGuardiola 👋 Would you be able to help write a dev note for this for the 6.7 release? We are planning to have this as part of a larger Miscellaneous Editor Updates note. We are hoping to get all drafts in by October 13th to leave some time for reviews before the RC1. All Dev Notes get tracked in #65784 so feel free to leave a note there or ping me directly :) Please let us know if you can assist with that. Thanks in advance :) |
draganescu
pushed a commit
that referenced
this pull request
Oct 2, 2024
* Refactor utils and switch Tabs indicator animation to `transform`. * docs tweak * Update packages/components/src/tabs/styles.ts Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> * Add RTL support. * Addressed @ciampo's comments. * Correct for antialiasing rounding. * Make antialiasing adjustment optional. * Use larger base value and revert antialiasing adjustment code. * DRY RTL * Remove RTL story (redundant since Storybook has a dynamic setting to test RTL). * Fix bug. * Fix bug (for real this time). * Add changelog entry. * De-cleverfy code. * Sync useResizeObserver with #64943 and make useTrackElementOffsetRect resilient. * Deduplicate utility and clean up. * Minor Tabs code improvement. * Replace framer motion animation with faster CSS animation. * DRY antialiasing factor. * Changelogs. * Various improvements, fixes, and feedback addressed. * Simplify. * Simplify using derived state. * Add similar useOnValueUpdate detail to Tabs. * Fix skipping animation. * Add similar detail to Tabs animation. * Fix setState depth issue. * Fix unit test error. * Add changelog entries * Fix changelog * Update test snapshot. * Depends less on React. * Switch to layout effect for `useOnValueUpdate` * Switched to transform strategy. * Fix resizing bug. * Transition border-radius too. * Undo Tabs changes (no longer relevant). * DRY animation code. * Avoid useless re-runs in effect. * Rename `activeElement` -> `selectedElement` for clarity. * Rename `--indicator-` -> `--selected-` for accuracy. * Minor tweak. * Add safe defaults to CSS custom properties. * Tweak `useSubelementAnimation`. * Fix parent missing when there's no selected option. * Update snapshots * Add docs to utility. * Added note about border-radius. --------- Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com> Co-authored-by: DaniGuardiola <daniguardiola@git.wordpress.org> Co-authored-by: ciampo <mciampini@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: mirka <0mirka00@git.wordpress.org>
|
Done: #65784 (comment) |
|
Hi, @DaniGuardiola Is there a plan to replace deprecated usages in the codebase with the new |
|
Hi @Mamaduka, I'm not allowed to contribute to WordPress anymore. Maybe @youknowriad or @jsnajdr can help out since they were involved in this effort. Cheers! |
|
@DaniGuardiola, sorry, I didn't know that :/ Thank for the reply 🙇 |
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.
Related to #64820 (needs to be merged first, and then this PR needs to be re-targeted to trunk)
What?
Add
useEventanduseObserveElementSizeto@wordpress/compose.useEventis a very common React utility (that might even make it one day to React core, in which case this utility won't be necessary anymore).useObserveElementSizeis whatuseResizeObserverprobably should have been: a very thin wrapper aroundResizeObserverfor use in React. The chosen naming is due to there being an existinguseResizeObserver(that does way more than abstractResizeObserver, and does it in a very opinionated way that, while useful, restricts mostResizeObserveruse cases in React).More details on the latter utility:
Why?
useResizeObserveris now simplified by usinguseObserveElementSizeunder the hood, which is made possible by the simplicity and composability of it.useEvent, hence why it's bundled in this PR instead of separate. It's a very lightweight utility though, and a well established pattern. In fact, the implementation is borrowed from Ariakit, which is used in production already by us, so we can rest assured that it works as intended.