Skip to content
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

Polish block moving animation #23401

Merged
merged 3 commits into from
Jun 24, 2020
Merged

Polish block moving animation #23401

merged 3 commits into from
Jun 24, 2020

Conversation

ellatrix
Copy link
Member

@ellatrix ellatrix commented Jun 23, 2020

Description

This PR fixes a long standing issue where moving a block up sometimes scrolls the page too much. This has been bugging me for a while... It seems like the browser itself already scrolls the page when moving the block in the DOM, so any scrolling done by us afterwards based on that will be off.

The solution is to calculate the block position before the block moves in the DOM. This can be done before rendering using useMemo. Once we have this scroll position, it's easy to restore the same position relative to the viewport.

Video of the bug being fixed:

move-scroll

How has this been tested?

Screenshots

Types of changes

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@ellatrix ellatrix requested a review from youknowriad as a code owner June 23, 2020 19:21
const scrollContainer = useRef();
const previous = useMemo(
() => ( ref.current ? getAbsolutePosition( ref.current ) : null ),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrapped this in useMemo as well. No need to fetch on every render.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this will produce bugs. say you type on a previous block more than a single line of text and you reorder afterward, it will use the original position and not the updated one (after typing)

Copy link
Contributor

@youknowriad youknowriad Jun 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh nevermind, I guess triggerAnimationOnChange ensures it's triggered before the animation, so it's fine. This could be a nice optimization.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it will always be recalculated before the effect is run.

@ellatrix ellatrix requested a review from jasmussen June 23, 2020 19:26
@ellatrix ellatrix added [Type] Bug An existing feature does not function as intended [Type] Code Quality Issues or PRs that relate to code quality labels Jun 23, 2020
@github-actions
Copy link

github-actions bot commented Jun 23, 2020

Size Change: +745 B (0%)

Total Size: 1.13 MB

Filename Size Change
build/block-directory/index.js 7.37 kB +100 B (1%)
build/block-directory/style-rtl.css 941 B +4 B (0%)
build/block-directory/style.css 942 B +5 B (0%)
build/block-editor/index.js 108 kB +468 B (0%)
build/block-editor/style-rtl.css 10.7 kB +59 B (0%)
build/block-editor/style.css 10.7 kB +59 B (0%)
build/block-library/editor-rtl.css 7.59 kB -1 B
build/block-library/editor.css 7.6 kB -2 B (0%)
build/block-library/index.js 129 kB +15 B (0%)
build/block-library/style-rtl.css 8.04 kB +2 B (0%)
build/block-library/style.css 8.04 kB +6 B (0%)
build/components/index.js 197 kB -24 B (0%)
build/data/index.js 8.44 kB -3 B (0%)
build/edit-post/index.js 303 kB +3 B (0%)
build/edit-post/style-rtl.css 5.5 kB +25 B (0%)
build/edit-post/style.css 5.5 kB +26 B (0%)
build/edit-site/index.js 16.6 kB -2 B (0%)
build/edit-widgets/index.js 9.32 kB -1 B
build/editor/index.js 44.9 kB +2 B (0%)
build/element/index.js 4.65 kB -2 B (0%)
build/format-library/index.js 7.73 kB +3 B (0%)
build/media-utils/index.js 5.29 kB +1 B
build/server-side-render/index.js 2.68 kB +2 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.62 kB 0 B
build/api-fetch/index.js 3.4 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-library/theme-rtl.css 730 B 0 B
build/block-library/theme.css 732 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.2 kB 0 B
build/components/style-rtl.css 15.8 kB 0 B
build/components/style.css 15.8 kB 0 B
build/compose/index.js 9.62 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/date/index.js 5.47 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.19 kB 0 B
build/edit-navigation/index.js 9.87 kB 0 B
build/edit-navigation/style-rtl.css 1.02 kB 0 B
build/edit-navigation/style.css 1.02 kB 0 B
build/edit-site/style-rtl.css 3.02 kB 0 B
build/edit-site/style.css 3.02 kB 0 B
build/edit-widgets/style-rtl.css 2.42 kB 0 B
build/edit-widgets/style.css 2.42 kB 0 B
build/editor/editor-styles-rtl.css 537 B 0 B
build/editor/editor-styles.css 539 B 0 B
build/editor/style-rtl.css 3.81 kB 0 B
build/editor/style.css 3.81 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 2.51 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.13 kB 0 B
build/list-reusable-blocks/style-rtl.css 450 B 0 B
build/list-reusable-blocks/style.css 451 B 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 663 B 0 B
build/nux/style.css 660 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.5 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 14 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@ellatrix ellatrix force-pushed the polish/block-move-animation branch from eb64fe3 to 385cb53 Compare June 23, 2020 19:50
@ellatrix
Copy link
Member Author

I think this animation is now butter smooth. 😄


// Calculate the previous position of the block relative to the viewport and
// return a function to maintain that position by scrolling.
const preserveScrollPosition = useMemo( () => {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All scroll logic is now nicely contained.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it 👍 We could return "noop" when we don't need to scroll to avoid the test done later.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't test now but the code looks good. Nice work

Copy link
Member

@ZebulanStanphill ZebulanStanphill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Combined with the improvements in #22640, moving blocks feels pretty much perfect now.

Comment on lines 136 to 138
if ( preserveScrollPosition ) {
preserveScrollPosition();
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting that using optional chaining, we can now do things like this, if we want to:

Suggested change
if ( preserveScrollPosition ) {
preserveScrollPosition();
}
preserveScrollPosition?.();

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@youknowriad What do you prefer? This or always return a function?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZebulanStanphill I'm getting a linting error:

Expected an assignment or function call and instead saw an expression.eslintno-unused-expressions

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a small preference for always returning a function but I consider all the three variations as code style preferences that don't deserve to be enforced. So your pick :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a preference, and the other option creates an error, so let's go for noop.

@jasmussen
Copy link
Contributor

I couldn't quite reproduce the initial issue, but things look good to me. I'll defer to the other wonderful people who already approved.

@ellatrix
Copy link
Member Author

@jasmussen Sometimes you have to press several times up, or the block has to be at a different side relative to the viewport.

@ellatrix ellatrix merged commit ea44697 into master Jun 24, 2020
@ellatrix ellatrix deleted the polish/block-move-animation branch June 24, 2020 19:42
@github-actions github-actions bot added this to the Gutenberg 8.5 milestone Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Bug An existing feature does not function as intended [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants