Skip to content

Remove support for sx from CheckboxGroup component#6655

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
llastflowers merged 7 commits into from
Sep 22, 2025
Merged

Remove support for sx from CheckboxGroup component #6655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
069ce2c
remove sx prop from CheckboxGroup.tsx
llastflowers Aug 22, 2025
c00446e
remove CheckboxGroup dev stories file because there was only one sx s…
llastflowers Aug 22, 2025
36a5397
remove sx from docs.json
llastflowers Aug 22, 2025
6789057
remove sx from e2e
llastflowers Aug 22, 2025
8fdba33
Update CheckboxGroup to remove sx support
llastflowers Aug 22, 2025
dbc270f
Merge branch 'main' into llastflowers/5760/no-sx-CheckboxGroup
llastflowers Sep 12, 2025
4eb192a
Merge branch 'main' into llastflowers/5760/no-sx-CheckboxGroup
llastflowers Sep 17, 2025
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
5 changes: 5 additions & 0 deletions .changeset/tame-ducks-ring.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@primer/react": major
---

Update CheckboxGroup component to no longer support sx
4 changes: 0 additions & 4 deletions e2e/components/CheckboxGroup.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@ const stories = [
title: 'Visually Hidden Label',
id: 'components-checkboxgroup-features--visually-hidden-label',
},
{
title: 'SX Props',
id: 'components-checkboxgroup-dev--sx-props',
},
] as const

test.describe('CheckboxGroup', () => {
Expand Down
48 changes: 0 additions & 48 deletions packages/react/src/CheckboxGroup/CheckboxGroup.dev.stories.tsx
View file
Open in desktop

This file was deleted.

22 changes: 1 addition & 21 deletions packages/react/src/CheckboxGroup/CheckboxGroup.docs.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,11 +61,6 @@
"type": "boolean",
"defaultValue": "false",
"description": "If true, the user must make a selection before the owning form can be submitted"
},
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
],
"subcomponents": [
Expand All@@ -77,11 +72,6 @@
"type": "boolean",
"defaultValue": "false",
"description": "If true, the fieldset legend will be visually hidden"
},
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
]
},
Expand All@@ -93,11 +83,6 @@
"type": "React.ReactNode",
"defaultValue": "",
"description": "The caption content"
},
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
]
},
Expand All@@ -116,13 +101,8 @@
"defaultValue": "",
"required": true,
"description": "Changes the visual style to match the validation status"
},
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
]
}
]
}
}
4 changes: 1 addition & 3 deletions packages/react/src/CheckboxGroup/CheckboxGroup.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@ import CheckboxOrRadioGroupCaption from '../internal/components/CheckboxOrRadioG
import CheckboxOrRadioGroupLabel from '../internal/components/CheckboxOrRadioGroup/CheckboxOrRadioGroupLabel'
import CheckboxOrRadioGroupValidation from '../internal/components/CheckboxOrRadioGroup/CheckboxOrRadioGroupValidation'
import {useRenderForcingRef} from '../hooks'
import type {SxProp} from '../sx'
import FormControl from '../FormControl'
import Checkbox from '../Checkbox/Checkbox'
import {CheckboxGroupContext} from './CheckboxGroupContext'
Expand All@@ -16,8 +15,7 @@ type CheckboxGroupProps = {
* An onChange handler that gets called when any of the checkboxes change
*/
onChange?: (selected: string[], e?: ChangeEvent<HTMLInputElement>) => void
} & CheckboxOrRadioGroupProps &
SxProp
} & CheckboxOrRadioGroupProps

const CheckboxGroup: FC<React.PropsWithChildren<CheckboxGroupProps>> = ({children, disabled, onChange, ...rest}) => {
const formControlComponentChildren = React.Children.toArray(children)
Expand Down
Loading