Site Editor: Improve the frame animation #60363
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -158,7 +158,6 @@ jobs: | |
| - name: Docker debug information | ||
| run: | | ||
| docker -v | ||
|
|
||
| - name: General debug information | ||
| run: | | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import { Controller } from '@react-spring/web'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { useLayoutEffect, useMemo, useRef } from '@wordpress/element'; | ||
|
|
||
| function getAbsolutePosition( element ) { | ||
| return { | ||
| top: element.offsetTop, | ||
| left: element.offsetLeft, | ||
| }; | ||
| } | ||
|
|
||
| const ANIMATION_DURATION = 300; | ||
|
|
||
| /** | ||
| * Hook used to compute the styles required to move a div into a new position. | ||
| * | ||
| * The way this animation works is the following: | ||
| * - It first renders the element as if there was no animation. | ||
| * - It takes a snapshot of the position of the block to use it | ||
| * as a destination point for the animation. | ||
| * - It restores the element to the previous position using a CSS transform | ||
| * - It uses the "resetAnimation" flag to reset the animation | ||
| * from the beginning in order to animate to the new destination point. | ||
| * | ||
| * @param {Object} $1 Options | ||
| * @param {*} $1.triggerAnimationOnChange Variable used to trigger the animation if it changes. | ||
| */ | ||
| function useMovingAnimation( { triggerAnimationOnChange } ) { | ||
|
There was a problem hiding this comment. Potentially this can be a generic hook in the compose package but I think the recent perf optimization that we've made to the block animation made it less likely to be shared. Maybe it's fine for it to be duplicated. (cc @ellatrix ) The other difference with the block animation is that this one animates the "width" and "height" as well as the position. |
||
| const ref = useRef(); | ||
|
|
||
| // Whenever the trigger changes, we need to take a snapshot of the current | ||
| // position of the block to use it as a destination point for the animation. | ||
| const { previous, prevRect } = useMemo( | ||
| () => ( { | ||
| previous: ref.current && getAbsolutePosition( ref.current ), | ||
| prevRect: ref.current && ref.current.getBoundingClientRect(), | ||
| } ), | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| [ triggerAnimationOnChange ] | ||
| ); | ||
|
|
||
| useLayoutEffect( () => { | ||
| if ( ! previous || ! ref.current ) { | ||
| return; | ||
| } | ||
|
|
||
| // We disable the animation if the user has a preference for reduced | ||
| // motion. | ||
| const disableAnimation = window.matchMedia( | ||
| '(prefers-reduced-motion: reduce)' | ||
| ).matches; | ||
|
|
||
| if ( disableAnimation ) { | ||
| return; | ||
| } | ||
|
|
||
| const controller = new Controller( { | ||
| x: 0, | ||
| y: 0, | ||
| width: prevRect.width, | ||
| height: prevRect.height, | ||
| config: { duration: ANIMATION_DURATION }, | ||
| onChange( { value } ) { | ||
| if ( ! ref.current ) { | ||
| return; | ||
| } | ||
| let { x, y, width, height } = value; | ||
| x = Math.round( x ); | ||
| y = Math.round( y ); | ||
| width = Math.round( width ); | ||
| height = Math.round( height ); | ||
| const finishedMoving = x === 0 && y === 0; | ||
| ref.current.style.transformOrigin = 'center center'; | ||
| ref.current.style.transform = finishedMoving | ||
| ? null // Set to `null` to explicitly remove the transform. | ||
| : `translate3d(${ x }px,${ y }px,0)`; | ||
| ref.current.style.width = finishedMoving | ||
| ? null | ||
| : `${ width }px`; | ||
| ref.current.style.height = finishedMoving | ||
| ? null | ||
| : `${ height }px`; | ||
| }, | ||
| } ); | ||
|
|
||
| ref.current.style.transform = undefined; | ||
| const destination = ref.current.getBoundingClientRect(); | ||
|
|
||
| const x = Math.round( prevRect.left - destination.left ); | ||
| const y = Math.round( prevRect.top - destination.top ); | ||
| const width = destination.width; | ||
| const height = destination.height; | ||
|
|
||
| controller.start( { | ||
| x: 0, | ||
| y: 0, | ||
| width, | ||
| height, | ||
| from: { x, y, width: prevRect.width, height: prevRect.height }, | ||
| } ); | ||
|
|
||
| return () => { | ||
| controller.stop(); | ||
| controller.set( { | ||
| x: 0, | ||
| y: 0, | ||
| width: prevRect.width, | ||
| height: prevRect.height, | ||
| } ); | ||
| }; | ||
| }, [ previous, prevRect ] ); | ||
|
|
||
| return ref; | ||
| } | ||
|
|
||
| export default useMovingAnimation; | ||
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
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
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
Oops, something went wrong.
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.
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.
Is this temporary to check what's causing the failures?
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.
I think this is what was causing the failures actually. I guess these days it's
docker composeand notdocker-composeand Github probably updated docker or something so the PHP tests started failing, I expect that they'll fail elsewhere as well.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.
Shall we merge this so we fix the tests in other PRs as well?