Skip to content

fix(combobox): keep local inputValue state in sync with Downshift #628

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

Merged
merged 1 commit into from
Mar 5, 2024
Merged

fix(combobox): keep local inputValue state in sync with Downshift #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
190 changes: 190 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 21 additions & 2 deletions packages/combobox/src/ComboboxContainer.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -894,21 +894,40 @@ describe('ComboboxContainer', () => {
});

it('handles controlled selection as expected', () => {
const _options = [{ value: 'test-1' }, { value: 'test-2' }, { value: 'test-3' }];

expect(listboxOptions[0]).toHaveAttribute('aria-selected', 'false');

rerender(
<TestCombobox
layout={layout}
options={[{ value: 'test-1' }, { value: 'test-2' }, { value: 'test-3' }]}
options={_options}
isExpanded={false}
inputValue=""
inputValue="test-1"
activeIndex={-1}
selectionValue="test-1"
onChange={handleChange}
/>
);

expect(listboxOptions[0]).toHaveAttribute('aria-selected', 'true');
expect(input).toHaveValue('test-1');

// simulate controlled selection change
rerender(
<TestCombobox
layout={layout}
options={_options}
isExpanded={false}
inputValue="test-2"
activeIndex={-1}
selectionValue="test-2"
onChange={handleChange}
/>
);

expect(listboxOptions[1]).toHaveAttribute('aria-selected', 'true');
expect(input).toHaveValue('test-2');
});

it('handles controlled multiple selection as expected', () => {
Expand Down
9 changes: 9 additions & 0 deletions packages/combobox/src/useCombobox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export const useCombobox = <
const [triggerContainsInput, setTriggerContainsInput] = useState<boolean>();
const [downshiftInputValue, setDownshiftInputValue] = useState(inputValue);
const [matchValue, setMatchValue] = useState('');
const useInputValueRef = useRef(true);
const matchTimeoutRef = useRef<number>();
const previousStateRef = useRef<IPreviousState>();
const prefix = useId(idPrefix);
Expand Down Expand Up @@ -142,6 +143,13 @@ export const useCombobox = <
return defaultActiveIndex;
}, [defaultActiveIndex, isAutocomplete, isEditable]);

if (useInputValueRef.current && inputValue !== downshiftInputValue) {
// Update local state with Downshift `inputValue` for non-buggy cases.
setDownshiftInputValue(inputValue);
} else {
useInputValueRef.current = true;
}

/*
* Validation
*/
Expand Down Expand Up @@ -645,6 +653,7 @@ export const useCombobox = <
// Override needed to workaround Downshift cursor bug.
// https://github.com/downshift-js/downshift/issues/1108
setDownshiftInputValue(event.target.value);
useInputValueRef.current = false;

// Override needed to workaround Downshift IME bug.
// https://github.com/downshift-js/downshift/issues/1452
Expand Down