Social Icons: Fix effect dependencies #69824
Merged
Conversation
This file contains hidden or 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
|
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. |
|
Size Change: +16 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
stokesman
approved these changes
Apr 4, 2025
There was a problem hiding this comment.
It’s nice to see the updater function leveraged 👍. I tested and it works as expected.
Aside: I question if `backgroundBackupRef` is necessary. The effect should only run when `logosOnly` changes so it seems a backup could be closed over by a cleanup function.
diff --git a/packages/block-library/src/social-links/edit.js b/packages/block-library/src/social-links/edit.js
index 4d0b522cbb..7e83807389 100644
--- a/packages/block-library/src/social-links/edit.js
+++ b/packages/block-library/src/social-links/edit.js
@@ -6,7 +6,7 @@ import clsx from 'clsx';
/**
* WordPress dependencies
*/
-import { useEffect, useRef } from '@wordpress/element';
+import { useEffect } from '@wordpress/element';
import {
BlockControls,
useInnerBlocksProps,
@@ -77,11 +77,11 @@ export function SocialLinksEdit( props ) {
// Remove icon background color when logos only style is selected or
// restore it when any other style is selected.
- const backgroundBackupRef = useRef( {} );
useEffect( () => {
if ( logosOnly ) {
+ let restore;
setAttributes( ( prev ) => {
- backgroundBackupRef.current = {
+ restore = {
iconBackgroundColor: prev.iconBackgroundColor,
iconBackgroundColorValue: prev.iconBackgroundColorValue,
customIconBackgroundColor: prev.customIconBackgroundColor,
@@ -92,8 +92,7 @@ export function SocialLinksEdit( props ) {
customIconBackgroundColor: undefined,
};
} );
- } else {
- setAttributes( { ...backgroundBackupRef.current } );
+ return () => setAttributes( restore );
}
}, [ logosOnly, setAttributes ] );
Another aside: I’m not concerned about it but I’ll note that this backup state can be lost due to remounts. For instance, if you change to logosOnly and then toggle “Show template” then switch away from logosOnly.
e2cf899 to
6be0402
Compare
|
Thanks, @stokesman! I like the idea of using the cleaup method for restoration; it feels more React-y. 😄
This can't be avoided. I think the current logic is only there to prevent color loss while the user is just experimenting and switching styles. |
|
Flaky tests detected in 6be0402. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/14302551062
|
chriszarate
pushed a commit
to chriszarate/gutenberg
that referenced
this pull request
Jul 1, 2025
* Social Icons: Fix effect dependencies * Use local variable Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: stokesman <presstoke@git.wordpress.org> Co-authored-by: getdave <get_dave@git.wordpress.org>
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.
What?
Closes #64896.
PR fixes missing dependencies
useEffectESLint warning for Social Icons block.How?
Use the new updater function for
setAttributesto store previous attribute values. This removes the need to list attributes as dependencies, which could cause triggering side effects unintentionally.Testing Instructions
Testing Instructions for Keyboard
Same.
Screenshots or screencast
CleanShot.2025-04-04.at.17.09.41.mp4