My Jetpack: Fix onboarding slider shift on window resize

[manzoorwanijk]

Fixes MYJP-111

@keoshi noticed that the My Jetpack onboarding carousel slides shift slightly when the browser window is resized.

Screen.Recording.2025-05-01.at.14.27.13.mov

The reason for the issue is that the container width in Swipeable component is stale for a moment when the window is resized and is not immediately applied to the slide, which is used by the DotPager component.

Proposed changes:

• Reset the Swipeable component local state when the window is resized by using an underrated feature of React - Resetting state with a key

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

• Disconnect your site - jetpack docker wp jetpack disconnect blog
• Go to My Jetpack
• Resize the browser window
• Confirm that the carousel slides do not shift

BEFORE	AFTER
Screen.Recording.2025-05-19.at.1.20.48.PM.mov	Screen.Recording.2025-05-19.at.1.21.52.PM.mov

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack or WordPress.com Site Helper), and enable the fix/my-jetpack/slider-shift-on-window-resize branch.
• To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack fix/my-jetpack/slider-shift-on-window-resize

bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/my-jetpack/slider-shift-on-window-resize

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  
• ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
3. You can use GitHub's Reviewers functionality to request a review.
4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

[jp-launch-control]

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

[grzegorz-cp]

This is a very innovative way to use keys, but using changing width as a key doesn't seem right to me. Introducing it to all Swipeable components also seems like an unnesary risk.
I think it would be better to fix it by either leveraging the resize observer or considering using throttle to optimise the resize events in the first place.

If this can't be avoided, passing this type of key from the consuming component that actually needs it (as outside props) would be a safer bet.

[manzoorwanijk]

Thank you @grzegorz-cp for raising those concerns. I explained the reason for this issue in the PR description.

but using changing width as a key doesn't seem right to me

The width will change only when the window resizes and that is exactly when we want the UI to reflect the changes.

considering using throttle to optimise the resize events in the first place

That won't solve this issue and throttling is already in place.

If this can't be avoided, passing this type of key from the consuming component that actually needs it (as outside props) would be a safer bet.

key is a special prop in React and it's not passed down as a prop to the component you pass it to. So, the consumer component won't know the changing width and thus won't make any difference.

Conclusion: It's a perfectly valid usage and most of the time, that key will be undefined as the window won't be resized all the time. So, the only time it gets used is when the browser window gets resized and that won't affect much of the component behavior, except that it reflects the UI immediately, which is what we want.

[grzegorz-cp]

Ah right, of course key is not passed down. I looked at { ...otherProps } in the code and thought about different props but applied it to keys.

Thanks 👍