Bug Report: Mismatch between Function Titles and Descriptions in Documentation
Description
There appears to be a mismatch between the function titles and their descriptions in the documentation. Specifically, the titles and descriptions for event handler functions are inconsistent, which may lead to confusion for developers integrating react-select into their projects.
Steps to Reproduce
Refer to the documentation of event handler functions like onKeyDown, onMenuOpen, and onMenuClose.
The descriptions don't align with what the functions actually do. For example, the onKeyDown function description mentions handling change events, whereas it should refer to handling key down events.
Expected Behavior
The function descriptions should correctly reflect their behavior. For example:
onKeyDown should be described as "Handle key down events on the input."
onMenuOpen should have a clear description that explains its function behavior related to menu opening.
onMenuClose should describe the action of closing the menu correctly.
Actual Behavior
The onKeyDown description refers to handling change events, which is misleading.
The descriptions of other functions may not accurately explain their behavior either.
Test Case
This issue is present in the documentation. A specific code example may not be necessary, but reviewing the relevant documentation for accuracy should suffice.
Versions
react-select: v5 (Latest)
Additional Notes
Providing accurate documentation helps developers better understand how to integrate and use these event handler functions in their projects. This small fix could prevent confusion and enhance the developer experience with react-select.
https://react-select.com/props#select-props
Bug Report: Mismatch between Function Titles and Descriptions in Documentation
Description
There appears to be a mismatch between the function titles and their descriptions in the documentation. Specifically, the titles and descriptions for event handler functions are inconsistent, which may lead to confusion for developers integrating
react-select
into their projects.Steps to Reproduce
onKeyDown
,onMenuOpen
, andonMenuClose
.onKeyDown
function description mentions handling change events, whereas it should refer to handling key down events.Expected Behavior
The function descriptions should correctly reflect their behavior. For example:
onKeyDown
should be described as "Handle key down events on the input."onMenuOpen
should have a clear description that explains its function behavior related to menu opening.onMenuClose
should describe the action of closing the menu correctly.Actual Behavior
onKeyDown
description refers to handling change events, which is misleading.Test Case
This issue is present in the documentation. A specific code example may not be necessary, but reviewing the relevant documentation for accuracy should suffice.
Versions
react-select
: v5 (Latest)Additional Notes
Providing accurate documentation helps developers better understand how to integrate and use these event handler functions in their projects. This small fix could prevent confusion and enhance the developer experience with
react-select
.