Skip to content
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

Jump to bottom

Fix prevent CheckboxGroupInput from changing selected values type #7248

Merged
merged 6 commits into from
Feb 16, 2022
Merged

Fix prevent CheckboxGroupInput from changing selected values type #7248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ceedeb5
Fix prevent CheckboxGroupInput from changing values type
WiXSL Feb 16, 2022
3f68038
Add tests
WiXSL Feb 16, 2022
9b9dac7
Apply review
WiXSL Feb 16, 2022
7cc4642
Apply review
WiXSL Feb 16, 2022
c782f0a
Use optionValue instead of id
WiXSL Feb 16, 2022
e5f4246
Flip condition for legibility
WiXSL Feb 16, 2022
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
60 changes: 60 additions & 0 deletions packages/ra-ui-materialui/src/input/CheckboxGroupInput.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,66 @@ describe('<CheckboxGroupInput />', () => {
expect(queryByText('Can I help you?')).not.toBeNull();
});

it('should not parse selected values types to numbers if all choices types are non numbers', () => {
const handleSubmit = jest.fn();
const { getByLabelText } = render(
<Form
onSubmit={handleSubmit}
initialValues={{ notifications: ['31', '42'] }}
render={({ handleSubmit }) => (
<form onSubmit={handleSubmit}>
<CheckboxGroupInput
source="notifications"
choices={[
{ id: '12', name: 'Ray Hakt' },
{ id: '31', name: 'Ann Gullar' },
{ id: '42', name: 'Sean Phonee' },
]}
/>
<button type="submit" aria-label="Save" />
</form>
)}
/>
);
const input = getByLabelText('Ray Hakt') as HTMLInputElement;
fireEvent.click(input);

fireEvent.click(getByLabelText('Save'));
expect(handleSubmit.mock.calls[0][0]).toEqual({
notifications: ['31', '42', '12'],
});
});

it('should parse selected values types to numbers if some choices are numbers', () => {
const handleSubmit = jest.fn();
const { getByLabelText } = render(
<Form
onSubmit={handleSubmit}
initialValues={{ notifications: [31, 42] }}
render={({ handleSubmit }) => (
<form onSubmit={handleSubmit}>
<CheckboxGroupInput
source="notifications"
choices={[
{ id: 12, name: 'Ray Hakt' },
{ id: 31, name: 'Ann Gullar' },
{ id: 42, name: 'Sean Phonee' },
]}
/>
<button type="submit" aria-label="Save" />
</form>
)}
/>
);
const input = getByLabelText('Ray Hakt') as HTMLInputElement;
fireEvent.click(input);

fireEvent.click(getByLabelText('Save'));
expect(handleSubmit.mock.calls[0][0]).toEqual({
notifications: [31, 42, 12],
});
});

describe('error message', () => {
it('should not be displayed if field is pristine', () => {
const { container } = render(
Expand Down
22 changes: 16 additions & 6 deletions packages/ra-ui-materialui/src/input/CheckboxGroupInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,21 +138,31 @@ const CheckboxGroupInput: FunctionComponent<CheckboxGroupInputProps> = props =>
const handleCheck = useCallback(
(event, isChecked) => {
let newValue;
try {
// try to convert string value to number, e.g. '123'
newValue = JSON.parse(event.target.value);
} catch (e) {
// impossible to convert value, e.g. 'abc'

if (
choices.every(
item => typeof get(item, optionValue) === 'number'
)
) {
try {
// try to convert string value to number, e.g. '123'
newValue = JSON.parse(event.target.value);
} catch (e) {
// impossible to convert value, e.g. 'abc'
newValue = event.target.value;
}
} else {
newValue = event.target.value;
}

if (isChecked) {
finalFormOnChange([...(value || []), ...[newValue]]);
} else {
finalFormOnChange(value.filter(v => v != newValue)); // eslint-disable-line eqeqeq
}
finalFormOnBlur(); // HACK: See https://github.com/final-form/react-final-form/issues/365#issuecomment-515045503
},
[finalFormOnChange, finalFormOnBlur, value]
[choices, finalFormOnBlur, optionValue, finalFormOnChange, value]
);

if (loading) {
Expand Down