Skip to content

[Autocomplete] Warn when using wrong getOptionSelected #19699

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 4 commits into from
Feb 20, 2020
Merged

[Autocomplete] Warn when using wrong getOptionSelected #19699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c58e436
warn when using wrong implementation of getOptionSelected
ahmad-reza619 Feb 14, 2020
063b380
replace error message to reflect number of matches
ahmad-reza619 Feb 16, 2020
45c4d78
prettier
ahmad-reza619 Feb 16, 2020
0bd00e0
add test case
oliviertassinari Feb 19, 2020
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
30 changes: 30 additions & 0 deletions packages/material-ui-lab/src/Autocomplete/Autocomplete.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,36 @@ describe('<Autocomplete />', () => {
'For the input option: "a", `getOptionLabel` returns: undefined',
);
});

it('warn if getOptionSelected match multiple values for a given option', () => {
const value = [{ id: '10', text: 'One' }, { id: '20', text: 'Two' }];
const options = [
{ id: '10', text: 'One' },
{ id: '20', text: 'Two' },
{ id: '30', text: 'Three' },
];

render(
<Autocomplete
{...defaultProps}
multiple
options={options}
value={value}
getOptionLabel={option => option.text}
getOptionSelected={option => value.find(v => v.id === option.id)}
renderInput={params => <TextField {...params} autoFocus />}
/>,
);

fireEvent.keyDown(document.activeElement, { key: 'ArrowDown' });
fireEvent.keyDown(document.activeElement, { key: 'ArrowDown' });
fireEvent.keyDown(document.activeElement, { key: 'Enter' });

expect(consoleErrorMock.callCount()).to.equal(1); // strict mode renders twice
expect(consoleErrorMock.args()[0][0]).to.include(
'The component expects a single value to match a given option but found 2 matches.',
);
});
});

describe('prop: options', () => {
Expand Down
15 changes: 15 additions & 0 deletions packages/material-ui-lab/src/useAutocomplete/useAutocomplete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,21 @@ export default function useAutocomplete(props) {
const item = newValue;
newValue = Array.isArray(value) ? [...value] : [];

if (process.env.NODE_ENV !== 'production') {
const matches = newValue.filter(val => getOptionSelected(item, val));

if (matches.length > 1) {
console.error(
[
'Material-UI: the `getOptionSelected` method of useAutocomplete do not handle the arguments correctly.',
`The component expects a single value to match a given option but found ${
matches.length
} matches.`,
].join('\n'),
);
}
}

const itemIndex = findIndex(newValue, valueItem => getOptionSelected(item, valueItem));

if (itemIndex === -1) {
Expand Down