FilterableMultiSelect onChange() not working as documented

[wdiu]

Bug - FilterableMultiSelect onChange() not working as documented

FilterableMultiSelect documents onChange() as:

/**
 * `onChange` is a utility for this controlled component to communicate to a
 * consuming component what kind of internal state changes are occuring.
 */
onChange: PropTypes.func,

However, in the code it only invoked when handling Downshift's onChange() which is only "Called when the selected item changes" according to Downshift's documentation here: https://github.com/downshift-js/downshift#onchange

Expected behavior -

To work as documented and communicate internal state changes, it needs to handle Downshift's onStateChange(), which according to Downshift's documentation: "This function is called anytime the internal state changes" https://github.com/downshift-js/downshift#onstatechange

Actual behavior -

onChange() is only called when the selected item changes.

Steps for reproducing

Look for "handleOnChange" in FilterableMultiSelect.js -- you will see it is mapped to Downshift's onChange() instead of onStateChange().

Screenshots

N/A - issue in code

Affected browsers

N/A - issue in code

Optional information

v1.23.0
I suggest adding an onStateChange() to avoid breaking the existing implementations of onChange().

[SimonFinney]

Hi @wdiu - Thanks for raising! There has been a recent PR to Carbon that may resolve this issue you've been experiencing - carbon-design-system/carbon#6427

If so, this will be included as part of their next release.

[wdiu]

Great, thanks, @SimonFinney!

[SimonFinney]

🎉 This issue has been resolved in version 1.33.0-prerelease.1 🎉

The release is available on:

• npm package (@canary dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[SimonFinney]

🎉 This issue has been resolved in version 1.33.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀