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

Add support for isLabelWrapped and component in Checkbox / Radio #9830

Merged
merged 8 commits into from
Jan 9, 2024
Merged

Add support for isLabelWrapped and component in Checkbox / Radio #9830

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3fcb92f
feat(Checkbox): add support for isLabelWrapped and isLabelBeforeButton
adamviktora Nov 20, 2023
4b30981
feat(Radio): add support for component
adamviktora Nov 20, 2023
c8fc07d
refactor(Radio/Checkbox): check isLabelBeforeButton only once
adamviktora Jan 9, 2024
6e0cc87
feat(Radio/Checkbox): add support for component === "label" behaving …
adamviktora Jan 9, 2024
9826eaa
docs(Radio/Checkbox): update props description
adamviktora Jan 9, 2024
5e90100
test(Checkbox): add unit tests
adamviktora Jan 9, 2024
b291817
test(Checkbox): unit test
adamviktora Jan 9, 2024
22f91ad
test(Radio): unit tests
adamviktora Jan 9, 2024
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
79 changes: 51 additions & 28 deletions packages/react-core/src/components/Checkbox/Checkbox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ export interface CheckboxProps
OUIAProps {
/** Additional classes added to the checkbox. */
adamviktora marked this conversation as resolved.
Show resolved Hide resolved
className?: string;
/** Additional classed added to the radio input */
/** Additional classed added to the checkbox input. */
inputClassName?: string;
/** Flag to show if the checkbox label is wrapped on small screen. Will only apply if component prop is not specified. */
adamviktora marked this conversation as resolved.
Show resolved Hide resolved
isLabelWrapped?: boolean;
/** Flag to show if the checkbox label is shown before the checkbox button. */
adamviktora marked this conversation as resolved.
Show resolved Hide resolved
isLabelBeforeButton?: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine but I wonder if in a breaking change we should rename this and the radio to remove the "button" part and use something more generic. isLabelBeforeInput would probably be more accurate, but it could just be isLabelStart or something along those lines - do we have any kind of pattern for naming props like this? This prop is a boolean, but the button and accordion have props iconPosition="[start/end]" and togglePosition=[start/end] that do something similar.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the core docs and it has a "Reversed" example, so possibly isReversed or isLabelReversed?

Screenshot 2024-01-09 at 11 11 12

I wonder whether we rename it now to have less codemods, or just keep it consistent in v5 so we keep the isLabelBeforeButton to match the Radio prop.

/** Flag to show if the checkbox selection is valid or invalid. */
isValid?: boolean;
/** Flag to show if the checkbox is disabled. */
Expand Down Expand Up @@ -52,13 +56,13 @@ class Checkbox extends React.Component<CheckboxProps, CheckboxState> {
static displayName = 'Checkbox';
static defaultProps: PickOptional<CheckboxProps> = {
className: '',
isLabelWrapped: false,
isValid: true,
isDisabled: false,
isRequired: false,
isChecked: false,
onChange: defaultOnChange,
ouiaSafe: true,
component: 'div'
ouiaSafe: true
};

constructor(props: any) {
Expand All @@ -78,6 +82,8 @@ class Checkbox extends React.Component<CheckboxProps, CheckboxState> {
className,
inputClassName,
onChange,
isLabelWrapped,
isLabelBeforeButton,
isValid,
isDisabled,
isRequired,
Expand All @@ -89,7 +95,7 @@ class Checkbox extends React.Component<CheckboxProps, CheckboxState> {
body,
ouiaId,
ouiaSafe,
component: Component,
component,
...props
} = this.props;
if (!props.id) {
Expand All @@ -107,32 +113,49 @@ class Checkbox extends React.Component<CheckboxProps, CheckboxState> {
checkedProps.defaultChecked = defaultChecked;
}

const inputRendered = (
<input
{...props}
className={css(styles.checkInput, inputClassName)}
type="checkbox"
onChange={this.handleChange}
aria-invalid={!isValid}
aria-label={ariaLabel}
disabled={isDisabled}
required={isRequired}
ref={(elem) => elem && (elem.indeterminate = isChecked === null)}
{...checkedProps}
{...getOUIAProps(Checkbox.displayName, ouiaId !== undefined ? ouiaId : this.state.ouiaStateId, ouiaSafe)}
/>
);

const wrapWithLabel = isLabelWrapped && !component;

const Label = wrapWithLabel ? 'span' : 'label';
const labelRendered = label ? (
<Label
className={css(styles.checkLabel, isDisabled && styles.modifiers.disabled)}
htmlFor={!wrapWithLabel && props.id}
>
{label}
{isRequired && (
<span className={css(styles.checkLabelRequired)} aria-hidden="true">
{ASTERISK}
</span>
)}
</Label>
) : null;

const Component = component ?? (wrapWithLabel ? 'label' : 'div');

checkedProps.checked = checkedProps.checked === null ? false : checkedProps.checked;
return (
<Component className={css(styles.check, !label && styles.modifiers.standalone, className)}>
<input
{...props}
className={css(styles.checkInput, inputClassName)}
type="checkbox"
onChange={this.handleChange}
aria-invalid={!isValid}
aria-label={ariaLabel}
disabled={isDisabled}
required={isRequired}
ref={(elem) => elem && (elem.indeterminate = isChecked === null)}
{...checkedProps}
{...getOUIAProps(Checkbox.displayName, ouiaId !== undefined ? ouiaId : this.state.ouiaStateId, ouiaSafe)}
/>
{label && (
<label className={css(styles.checkLabel, isDisabled && styles.modifiers.disabled)} htmlFor={props.id}>
{label}
{isRequired && (
<span className={css(styles.checkLabelRequired)} aria-hidden="true">
{ASTERISK}
</span>
)}
</label>
)}
<Component
className={css(styles.check, !label && styles.modifiers.standalone, className)}
htmlFor={wrapWithLabel && props.id}
>
{isLabelBeforeButton ? labelRendered : inputRendered}
adamviktora marked this conversation as resolved.
Show resolved Hide resolved
{isLabelBeforeButton ? inputRendered : labelRendered}
{description && <span className={css(styles.checkDescription)}>{description}</span>}
{body && <span className={css(styles.checkBody)}>{body}</span>}
</Component>
Expand Down
66 changes: 29 additions & 37 deletions packages/react-core/src/components/Radio/Radio.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ import { getOUIAProps, OUIAProps, getDefaultOUIAId } from '../../helpers';
export interface RadioProps
extends Omit<React.HTMLProps<HTMLInputElement>, 'disabled' | 'label' | 'onChange' | 'type'>,
OUIAProps {
/** Additional classes added to the radio wrapper. This will be a div element if
* isLabelWrapped is true, otherwise this will be a label element.
/** Additional classes added to the radio wrapper. This will be a label element if
* isLabelWrapped is true, otherwise this will be a div element.
*/
className?: string;
/** Additional classed added to the radio input */
/** Additional classed added to the radio input. */
inputClassName?: string;
/** Id of the radio. */
id: string;
/** Flag to show if the radio label is wrapped on small screen. */
/** Flag to show if the radio label is wrapped on small screen. Will only apply if component prop is not specified. */
adamviktora marked this conversation as resolved.
Show resolved Hide resolved
isLabelWrapped?: boolean;
/** Flag to show if the radio label is shown before the radio button. */
isLabelBeforeButton?: boolean;
Expand All @@ -39,6 +39,8 @@ export interface RadioProps
description?: React.ReactNode;
/** Body of the radio. */
body?: React.ReactNode;
/** Sets the input wrapper component to render. Defaults to <div> */
component?: React.ElementType;
/** Value to overwrite the randomly generated data-ouia-component-id.*/
ouiaId?: number | string;
/** Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false. */
Expand Down Expand Up @@ -88,6 +90,7 @@ class Radio extends React.Component<RadioProps, { ouiaStateId: string }> {
body,
ouiaId,
ouiaSafe = true,
component,
...props
} = this.props;
if (!props.id) {
Expand All @@ -110,41 +113,30 @@ class Radio extends React.Component<RadioProps, { ouiaStateId: string }> {
/>
);

let labelRendered: React.ReactNode = null;
if (label && isLabelWrapped) {
labelRendered = <span className={css(styles.radioLabel, isDisabled && styles.modifiers.disabled)}>{label}</span>;
} else if (label) {
labelRendered = (
<label className={css(styles.radioLabel, isDisabled && styles.modifiers.disabled)} htmlFor={props.id}>
{label}
</label>
);
}
const wrapWithLabel = isLabelWrapped && !component;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a thought, if the user passes component="label" then they'll end up with nested label elements. We could treat component="label" and isLabelWrapped the same.

Suggested change
const wrapWithLabel = isLabelWrapped && !component;
const wrapWithLabel = isLabelWrapped && (!component || component === 'label');

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea! We could possibly remove the isLabelWrapped prop as a breaking change in v6 and replace it entirely with just component="label"


const descRender = description ? <span className={css(styles.radioDescription)}>{description}</span> : null;
const bodyRender = body ? <span className={css(styles.radioBody)}>{body}</span> : null;
const childrenRendered = isLabelBeforeButton ? (
<>
{labelRendered}
{inputRendered}
{descRender}
{bodyRender}
</>
) : (
<>
{inputRendered}
{labelRendered}
{descRender}
{bodyRender}
</>
);
const Label = wrapWithLabel ? 'span' : 'label';
const labelRendered = label ? (
<Label
className={css(styles.radioLabel, isDisabled && styles.modifiers.disabled)}
htmlFor={!wrapWithLabel && props.id}
>
{label}
</Label>
) : null;

const Component = component ?? (wrapWithLabel ? 'label' : 'div');

return isLabelWrapped ? (
<label className={css(styles.radio, className)} htmlFor={props.id}>
{childrenRendered}
</label>
) : (
<div className={css(styles.radio, !label && styles.modifiers.standalone, className)}>{childrenRendered}</div>
return (
<Component
className={css(styles.radio, !label && styles.modifiers.standalone, className)}
htmlFor={wrapWithLabel && props.id}
>
{isLabelBeforeButton ? labelRendered : inputRendered}
adamviktora marked this conversation as resolved.
Show resolved Hide resolved
{isLabelBeforeButton ? inputRendered : labelRendered}
{description && <span className={css(styles.radioDescription)}>{description}</span>}
{body && <span className={css(styles.radioBody)}>{body}</span>}
</Component>
);
}
}
Expand Down
Loading