Skip to content

Components: Add disabled prop to CheckBoxControl #69726

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

Open
im3dabasia wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Components: Add disabled prop to CheckBoxControl #69726

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
25 changes: 22 additions & 3 deletions packages/components/src/checkbox-control/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export function CheckboxControl(
indeterminate,
help,
id: idProp,
disabled,
onChange,
...additionalProps
} = props;
Expand Down Expand Up @@ -89,8 +90,13 @@ export function CheckboxControl(
'inspector-checkbox-control',
idProp
);
const onChangeValue = ( event: ChangeEvent< HTMLInputElement > ) =>
const onChangeValue = ( event: ChangeEvent< HTMLInputElement > ) => {
if ( disabled ) {
return;
}

onChange( event.target.checked );
};

return (
<BaseControl
Expand All @@ -108,14 +114,22 @@ export function CheckboxControl(
className={ clsx( 'components-checkbox-control', className ) }
>
<HStack spacing={ 0 } justify="start" alignment="top">
<span className="components-checkbox-control__input-container">
<span
className={ clsx(
'components-checkbox-control__input-container',
{
'is-disabled': disabled,
}
) }
>
<input
ref={ ref }
id={ id }
className="components-checkbox-control__input"
type="checkbox"
value="1"
onChange={ onChangeValue }
aria-disabled={ disabled }
checked={ checked }
aria-describedby={ !! help ? id + '__help' : undefined }
{ ...additionalProps }
Expand All @@ -137,7 +151,12 @@ export function CheckboxControl(
</span>
{ label && (
<label
className="components-checkbox-control__label"
className={ clsx(
'components-checkbox-control__label',
{
'is-disabled': disabled,
}
) }
htmlFor={ id }
>
{ label }
Expand Down
1 change: 1 addition & 0 deletions packages/components/src/checkbox-control/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ const meta: Meta< typeof CheckboxControl > = {
control: false,
},
help: { control: { type: 'text' } },
disabled: { control: { type: 'boolean' } },
},
parameters: {
controls: {
Expand Down
10 changes: 9 additions & 1 deletion packages/components/src/checkbox-control/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@
.components-checkbox-control__label {
// Ensure label is aligned with checkbox along X axis
line-height: var(--checkbox-input-size);
cursor: pointer;

&:not(.is-disabled) {
cursor: pointer;
}
}

.components-checkbox-control__input[type="checkbox"] {
Expand Down Expand Up @@ -66,6 +69,11 @@
aspect-ratio: 1;
line-height: 1; // maintains proper height even with WP common.css
flex-shrink: 0;

// Disabled state:
&.is-disabled {
opacity: 0.3;
}
}

svg.components-checkbox-control__checked,
Expand Down
5 changes: 5 additions & 0 deletions packages/components/src/checkbox-control/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,9 @@ export type CheckboxControlProps = Pick<
* @deprecated
*/
heading?: ReactNode;
/**
* If disabled is true the checkbox will be disabled and apply the appropriate
* styles.
*/
disabled?: boolean;
};
Loading