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.

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

[BD-46] fix: fixed duplicate calls in FormRadioSet and FormCheckboxSet #2705

Merged
merged 3 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 12 additions & 8 deletions src/Form/FormCheckbox.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,30 +62,27 @@ const FormCheckbox = React.forwardRef(({
floatLabelLeft,
...props
}, ref) => {
const { getCheckboxControlProps, hasCheckboxSetProvider } = useCheckboxSetContext();
const { hasCheckboxSetProvider } = useCheckboxSetContext();
const { hasFormGroupProvider, useSetIsControlGroupEffect, getControlProps } = useFormGroupContext();
useSetIsControlGroupEffect(true);
const shouldActAsGroup = hasFormGroupProvider && !hasCheckboxSetProvider;
const groupProps = shouldActAsGroup ? {
...getControlProps({}),
role: 'group',
} : {};
const checkboxInputProps = getCheckboxControlProps({
...props,
className: controlClassName,
});
const control = React.createElement(controlAs, { ...checkboxInputProps, ref });

const control = React.createElement(controlAs, { ...props, className: controlClassName, ref });
return (
<FormGroupContextProvider
controlId={checkboxInputProps.id}
controlId={props.id}
isInvalid={isInvalid}
isValid={isValid}
>
<div
className={classNames('pgn__form-checkbox', className, {
'pgn__form-control-valid': isValid,
'pgn__form-control-invalid': isInvalid,
'pgn__form-control-disabled': checkboxInputProps.disabled,
'pgn__form-control-disabled': props.disabled,
'pgn__form-control-label-left': !!floatLabelLeft,
})}
{...groupProps}
Expand All @@ -107,6 +104,8 @@ const FormCheckbox = React.forwardRef(({
});

FormCheckbox.propTypes = {
/** Specifies id of the FormCheckbox component. */
id: PropTypes.string,
/** Specifies contents of the component. */
children: PropTypes.node.isRequired,
/** Specifies class name to append to the base element. */
Expand All @@ -123,10 +122,14 @@ FormCheckbox.propTypes = {
isValid: PropTypes.bool,
/** Specifies control element. */
controlAs: PropTypes.elementType,
/** Specifies whether the floating label should be aligned to the left. */
floatLabelLeft: PropTypes.bool,
/** Specifies whether the `FormCheckbox` is disabled. */
disabled: PropTypes.bool,
};

FormCheckbox.defaultProps = {
id: undefined,
className: undefined,
controlClassName: undefined,
labelClassName: undefined,
Expand All @@ -135,6 +138,7 @@ FormCheckbox.defaultProps = {
isValid: false,
controlAs: CheckboxControl,
floatLabelLeft: false,
disabled: false,
};

export { CheckboxControl };
Expand Down
63 changes: 31 additions & 32 deletions src/Form/FormRadio.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,42 +40,37 @@ const FormRadio = React.forwardRef(({
isInvalid,
isValid,
...props
}, ref) => {
const { getRadioControlProps } = useRadioSetContext();
const radioInputProps = getRadioControlProps({
...props,
className: controlClassName,
});
return (
<FormGroupContextProvider
controlId={radioInputProps.id}
isInvalid={isInvalid}
isValid={isValid}
}, ref) => (
<FormGroupContextProvider
controlId={props.id}
isInvalid={isInvalid}
isValid={isValid}
>
<div
className={classNames('pgn__form-radio', className, {
'pgn__form-control-valid': isValid,
'pgn__form-control-invalid': isInvalid,
'pgn__form-control-disabled': props.disabled,
})}
>
<div
className={classNames('pgn__form-radio', className, {
'pgn__form-control-valid': isValid,
'pgn__form-control-invalid': isInvalid,
'pgn__form-control-disabled': radioInputProps.disabled,
})}
>
<RadioControl {...radioInputProps} ref={ref} />
<div>
<FormLabel className={labelClassName}>
{children}
</FormLabel>
{description && (
<FormControlFeedback hasIcon={false}>
{description}
</FormControlFeedback>
)}
</div>
<RadioControl ref={ref} className={controlClassName} {...props} />
<div>
<FormLabel className={labelClassName}>
{children}
</FormLabel>
{description && (
<FormControlFeedback hasIcon={false}>
{description}
</FormControlFeedback>
)}
</div>
</FormGroupContextProvider>
);
});
</div>
</FormGroupContextProvider>
));

FormRadio.propTypes = {
/** Specifies id of the FormRadio component. */
id: PropTypes.string,
/** Specifies contents of the component. */
children: PropTypes.node.isRequired,
/** Specifies class name to append to the base element. */
Expand All @@ -90,15 +85,19 @@ FormRadio.propTypes = {
isInvalid: PropTypes.bool,
/** Specifies whether to display component in valid state, this affects styling. */
isValid: PropTypes.bool,
/** Specifies whether the `FormRadio` is disabled. */
disabled: PropTypes.bool,
};

FormRadio.defaultProps = {
id: undefined,
className: undefined,
controlClassName: undefined,
labelClassName: undefined,
description: undefined,
isInvalid: false,
isValid: false,
disabled: false,
};

export { RadioControl };
Expand Down
19 changes: 19 additions & 0 deletions src/Form/tests/FormCheckboxSet.test.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,23 @@ describe('FormCheckboxSet', () => {
expect(checkboxNode.defaultChecked).toBe(true);
});
});

it('checks if onClick is called once in FormCheckboxSet', () => {
const handleChange = jest.fn();
const { getByLabelText } = render(
<FormGroup controlId="my-field">
<FormLabel>Which color?</FormLabel>
<FormCheckboxSet
name="colors"
onChange={handleChange}
>
<FormCheckbox value="red">Red</FormCheckbox>
<FormCheckbox value="green">Green</FormCheckbox>
</FormCheckboxSet>
</FormGroup>,
);

userEvent.click(getByLabelText('Red'));
expect(handleChange).toHaveBeenCalledTimes(1);
});
});
19 changes: 19 additions & 0 deletions src/Form/tests/FormRadioSet.test.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,23 @@ describe('FormRadioSet', () => {
expect(evergreenRadio).toHaveAttribute('name', 'trees');
expect(deciduousRadio).toHaveAttribute('name', 'trees');
});

it('checks if onClick is called once in FormRadioSet', () => {
const handleChange = jest.fn();
const { getByLabelText } = render(
<FormGroup>
<FormLabel>Which color?</FormLabel>
<FormRadioSet
name="colors"
onChange={handleChange}
>
<FormRadio value="red">Red</FormRadio>
<FormRadio value="green">Green</FormRadio>
</FormRadioSet>
</FormGroup>,
);

userEvent.click(getByLabelText('Red'));
expect(handleChange).toHaveBeenCalledTimes(1);
});
});
1 change: 1 addition & 0 deletions src/Menu/__snapshots__/Menu.test.jsx.snap
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ exports[`Menu Item renders correctly renders as expected with menu items 1`] = `
>
<input
className="pgn__form-checkbox-input"
disabled={false}
id="form-field1"
type="checkbox"
/>
Expand Down
Loading