diff --git a/.changeset/tame-ducks-ring.md b/.changeset/tame-ducks-ring.md new file mode 100644 index 00000000000..2fde4d6b218 --- /dev/null +++ b/.changeset/tame-ducks-ring.md @@ -0,0 +1,5 @@ +--- +"@primer/react": major +--- + +Update CheckboxGroup component to no longer support sx diff --git a/e2e/components/CheckboxGroup.test.ts b/e2e/components/CheckboxGroup.test.ts index d8f0ca44264..adb846d93f8 100644 --- a/e2e/components/CheckboxGroup.test.ts +++ b/e2e/components/CheckboxGroup.test.ts @@ -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', () => { diff --git a/packages/react/src/CheckboxGroup/CheckboxGroup.dev.stories.tsx b/packages/react/src/CheckboxGroup/CheckboxGroup.dev.stories.tsx deleted file mode 100644 index 2a7130df9e4..00000000000 --- a/packages/react/src/CheckboxGroup/CheckboxGroup.dev.stories.tsx +++ /dev/null @@ -1,48 +0,0 @@ -import type {Meta} from '@storybook/react-vite' -import {Checkbox, CheckboxGroup, FormControl} from '..' - -export default { - title: 'Components/CheckboxGroup/Dev', - component: CheckboxGroup, - parameters: {controls: {exclude: ['aria-labelledby', 'id', 'onChange', 'sx']}}, -} as Meta - -export const SxProps = () => ( - - - Caption - - - Choices - - - - Choice one - - - - Choice two - - - - Choice three - - -) diff --git a/packages/react/src/CheckboxGroup/CheckboxGroup.docs.json b/packages/react/src/CheckboxGroup/CheckboxGroup.docs.json index 6db6a947822..171bf3987de 100644 --- a/packages/react/src/CheckboxGroup/CheckboxGroup.docs.json +++ b/packages/react/src/CheckboxGroup/CheckboxGroup.docs.json @@ -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": [ @@ -77,11 +72,6 @@ "type": "boolean", "defaultValue": "false", "description": "If true, the fieldset legend will be visually hidden" - }, - { - "name": "sx", - "type": "SystemStyleObject", - "deprecated": true } ] }, @@ -93,11 +83,6 @@ "type": "React.ReactNode", "defaultValue": "", "description": "The caption content" - }, - { - "name": "sx", - "type": "SystemStyleObject", - "deprecated": true } ] }, @@ -116,13 +101,8 @@ "defaultValue": "", "required": true, "description": "Changes the visual style to match the validation status" - }, - { - "name": "sx", - "type": "SystemStyleObject", - "deprecated": true } ] } ] -} \ No newline at end of file +} diff --git a/packages/react/src/CheckboxGroup/CheckboxGroup.tsx b/packages/react/src/CheckboxGroup/CheckboxGroup.tsx index b519bd85b27..c75c27ca61e 100644 --- a/packages/react/src/CheckboxGroup/CheckboxGroup.tsx +++ b/packages/react/src/CheckboxGroup/CheckboxGroup.tsx @@ -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' @@ -16,8 +15,7 @@ type CheckboxGroupProps = { * An onChange handler that gets called when any of the checkboxes change */ onChange?: (selected: string[], e?: ChangeEvent) => void -} & CheckboxOrRadioGroupProps & - SxProp +} & CheckboxOrRadioGroupProps const CheckboxGroup: FC> = ({children, disabled, onChange, ...rest}) => { const formControlComponentChildren = React.Children.toArray(children)