JedWatson / react-select

The Select Component for React.js
https://react-select.com/
MIT License
27.53k stars 4.12k forks source link

`onInputChange` documentation does not reflect behavior #5677

Open 7PH opened 1 year ago

7PH commented 1 year ago

Documentation of the onInputChange return type does not reflect its actual return type, and what can be done with it

In the doc, return type is void image

But while implementing my use-case, I found out that this is actually possible using the return type of this same method, for example here. This is also shown in this example in this same repository.

It seems to me that the documentation should be aligned with the real return value of this method, which is string | undefined AFAIK

WDYT? If you agree with this, I am eager to create a PR for it.

aerialist7 commented 2 months ago

I faced the same problem

Yep, it should be aligned. @7PH, please make a PR

7PH commented 2 months ago

Wow, completly forgot about this, I'll check and see if that's a quick fix

7PH commented 2 months ago

That's not a quick fix

Unfortunately, I don't have the time at the moment to fix this now. I still think this is an issue and should be fixed, so I'll keep the issue open for now.