Skip to content

Add autoFocusOption prop to disable focusing an option until the user provides input #6067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+20 −6
Open

Add autoFocusOption prop to disable focusing an option until the user provides input #6067

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20aabf9
Add autoFocusOption prop
6uzm4n Sep 10, 2025
a38c87e
Prettify code
6uzm4n Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions packages/react-select/src/Select.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ export interface Props<
ariaLiveMessages?: AriaLiveMessages<Option, IsMulti, Group>;
/** Focus the control when it is mounted */
autoFocus?: boolean;
/** Focus an option when no inputValue is given */
autoFocusOption?: boolean;
/** Remove the currently focused option when the user presses backspace when Select isClearable or isMulti */
backspaceRemovesValue: boolean;
/** Remove focus from the input when the user selects an option (handy for dismissing the keyboard on touch devices) */
Expand Down Expand Up @@ -281,6 +283,7 @@ export interface Props<

export const defaultProps = {
'aria-live': 'polite',
autoFocusOption: true,
backspaceRemovesValue: true,
blurInputOnSelect: isTouchCapable(),
captureMenuScroll: !isTouchCapable(),
Expand Down Expand Up @@ -529,11 +532,17 @@ function getNextFocusedOption<
Option,
IsMulti extends boolean,
Group extends GroupBase<Option>
>(state: State<Option, IsMulti, Group>, options: Options<Option>) {
>(
props: Props<Option, IsMulti, Group>,
state: State<Option, IsMulti, Group>,
options: Options<Option>
) {
const { focusedOption: lastFocusedOption } = state;
return lastFocusedOption && options.indexOf(lastFocusedOption) > -1
? lastFocusedOption
: options[0];
const { autoFocusOption } = props;
if (lastFocusedOption && options.indexOf(lastFocusedOption) > -1) {
return lastFocusedOption;
}
return !props.inputValue && !autoFocusOption ? null : options[0];
}

const getFocusedOptionId = <Option,>(
Expand Down Expand Up @@ -740,7 +749,11 @@ export default class Select<
const focusedValue = clearFocusValueOnUpdate
? getNextFocusedValue(state, selectValue)
: null;
const focusedOption = getNextFocusedOption(state, focusableOptions);
const focusedOption = getNextFocusedOption(
props,
state,
focusableOptions
);
const focusedOptionId = getFocusedOptionId(
focusableOptionsWithIds,
focusedOption
Expand Down Expand Up @@ -903,6 +916,7 @@ export default class Select<

openMenu(focusOption: 'first' | 'last') {
const { selectValue, isFocused } = this.state;
const { autoFocusOption } = this.props;
const focusableOptions = this.buildFocusableOptions();
let openAtIndex = focusOption === 'first' ? 0 : focusableOptions.length - 1;

Expand All @@ -920,7 +934,7 @@ export default class Select<
{
inputIsHiddenAfterUpdate: false,
focusedValue: null,
focusedOption: focusableOptions[openAtIndex],
focusedOption: autoFocusOption ? focusableOptions[openAtIndex] : null,
focusedOptionId: this.getFocusedOptionId(focusableOptions[openAtIndex]),
},
() => this.onMenuOpen()
Expand Down