Add support for some user supplied props in ColorGradientSettingsDropdown

[permafrost06]

What?

In the ColorGradientSettingsDropdown component in @wordpress/block-editor, props onDeselect and hasValue can be supplied by the user. if they're undefined or not a function, falls back to the default behavior.

Why?

The current behavior assumes that the default color value is empty - which isn't true sometimes. This small PR solves that.

How?

It checks whether or not the props setting.onDeselect and setting.hasValue for the component ColorGradientSettingsDropdown are functions. If they are functions, then they are run respectively when a color is reset and to check if the control has a value.

Testing Instructions

1. Import the ColorGradientSettingsDropdown component from @wordpress/block-editor package.
2. Set it up as needed, then include test functions for properties onDeselect and hasValue in a setting object. Example:

<ColorGradientSettingsDropdown
    enableAlpha
    panelId={clientId}
    title={__("Color Settings", "plugin_textdomain")}
    popoverProps={{
        placement: "left start",
    }}
    settings={[{
        /* rest of your settings */
        onDeselect: () => {
            console.log("color deselected");
            setAttribute({ starColor: "#FFB901" });
        }
        hasValue: () => {
            if (starColor.toUpperCase() !== "#FFB901") {
                return true;
            }
            return false;
        }
    }]}
/>

Testing Instructions for Keyboard

Screenshots or screencast

[github-actions]

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.

• Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
• Labels found: .

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.

[github-actions]

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: permafrost06 <[email protected]>
Co-authored-by: carolinan <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @permafrost06! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

[carolinan]

Hi @permafrost06
Is there an open issue related to this pull request?
Having an issue with clear descriptions of the problem and use cases helps other contributors understand the enhancement or bug, and if the pull request is the correct solution. It also helps contributors learn if it is an issue that needs to be prioritised.

https://developer.wordpress.org/block-editor/contributors/repository-management/#pull-requests

[permafrost06]

@carolinan I don't think there is an open issue related to this PR. I faced this problem while developing a block and created this PR since the fix was quite simple. If you want, I can create an issue that illustrates what problem I faced or I can create a comment on the PR with more details. Please let me know which I should do. Thank you.

[carolinan]

Yes please open an issue since it is considered the best practice.
Please expand on the use case and what the proposed changes solve.

[permafrost06]

@carolinan I have opened an issue #60536 that describes the problem this PR fixes.

This PR adds support for the hasValue and onDeselect props in the component ColorGradientSettingsDropdown.
In the implementation, it's checked whether the passed hasValue and onDeselect property values are functions. If they are functions, then they are run respectively to check whether the control has a value, therefore can be reset and when a single value is reset. If, however, the passed values are not functions, or they're not passed (i.e. they're undefined), the old behaviour is used where the attribute is set to undefined on resetting the value.