Skip to content

feat(ButtonGroup): remove support for sx #6835

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

feat(ButtonGroup): remove support for sx #6835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1685da2
feat(ButtonGroup): remove support for sx
joshblack Sep 10, 2025
2446936
chore: add changeset
joshblack Sep 10, 2025
c0b0527
test(e2e): remove sx prop vrt tests
joshblack Sep 10, 2025
708426e
Merge branch 'main' into feat/remove-support-for-sx-from-buttongroup
joshblack Sep 16, 2025
844f8b5
Merge branch 'main' into feat/remove-support-for-sx-from-buttongroup
francinelucca Sep 22, 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/light-colts-burn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': major
---

Remove support for `sx` from `ButtonGroup`
Binary file removed ...nts/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-dark-colorblind-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...ponents/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-dark-dimmed-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed .../ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-dark-high-contrast-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...ots/components/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-dark-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...nts/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-dark-tritanopia-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...ts/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-light-colorblind-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-light-high-contrast-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...ts/components/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-light-linux.png
View file
Open in desktop
Binary file not shown.
Binary file removed ...ts/ButtonGroup.test.ts-snapshots/ButtonGroup-SX-Prop-light-tritanopia-linux.png
View file
Open in desktop
Binary file not shown.
4 changes: 0 additions & 4 deletions e2e/components/ButtonGroup.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ const stories = [
title: 'Overrides',
id: 'components-buttongroup-dev--link-button-with-icon-buttons',
},
{
title: 'SX Prop',
id: 'components-buttongroup-dev--sx-prop',
},
] as const

test.describe('ButtonGroup', () => {
Expand Down
12 changes: 2 additions & 10 deletions packages/react/src/ButtonGroup/ButtonGroup.dev.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const meta: Meta<typeof ButtonGroup> = {
export default meta

export const LinkAndButtonWithTooltip2 = () => (
<ButtonGroup sx={{pl: 2}}>
<ButtonGroup style={{paddingLeft: '8px'}}>
<Tooltip text="Additional info about the link">
<Button as="a" href="https://primer.style">
Link
Expand All @@ -35,7 +35,7 @@ export const LinkAndButtonWithTooltip2 = () => (
)

export const ButtonAndLinkWithTooltip2 = () => (
<ButtonGroup sx={{pl: 2}}>
<ButtonGroup style={{paddingLeft: '8px'}}>
<IconButton icon={CopilotIcon} aria-label="Open GitHub Copilot chat" />
<Tooltip text="Additional info about the link">
<Button as="a" href="https://primer.style">
Expand All @@ -62,11 +62,3 @@ export const LinkButtonWithIconButtons = () => (
<IconButton icon={CopilotIcon} aria-label="Open GitHub Copilot chat" />
</ButtonGroup>
)

export const SxProp = () => (
<ButtonGroup sx={{border: '1px solid red'}}>
<Button>Button 1</Button>
<Button>Button 2</Button>
<Button>Button 3</Button>
</ButtonGroup>
)
5 changes: 0 additions & 5 deletions packages/react/src/ButtonGroup/ButtonGroup.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,6 @@
],
"importPath": "@primer/react",
"props": [
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
},
{
"name": "ref",
"type": "React.RefObject<HTMLDivElement>"
Expand Down
15 changes: 6 additions & 9 deletions packages/react/src/ButtonGroup/ButtonGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
import React, {type PropsWithChildren} from 'react'
import {type SxProp} from '../sx'
import classes from './ButtonGroup.module.css'
import {clsx} from 'clsx'
import {FocusKeys, useFocusZone} from '../hooks/useFocusZone'
import {useProvidedRefOrCreate} from '../hooks'
import type {ForwardRefComponent as PolymorphicForwardRefComponent} from '../utils/polymorphic'
import {BoxWithFallback} from '../internal/components/BoxWithFallback'

export type ButtonGroupProps = {
export type ButtonGroupProps = PropsWithChildren<{
/** The role of the group */
role?: string
/** className passed in for styling */
className?: string
} & PropsWithChildren &
SxProp
}>

const ButtonGroup = React.forwardRef<HTMLElement, ButtonGroupProps>(function ButtonGroup(
{children, className, role, ...rest},
const ButtonGroup = React.forwardRef(function ButtonGroup(
{as: BaseComponent = 'div', children, className, role, ...rest},
Comment on lines +15 to +16
Copy link

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

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

The as prop is destructured but not included in the ButtonGroupProps type definition. This creates a mismatch between the component's actual interface and its declared props type, which could confuse consumers and break TypeScript IntelliSense.

Copilot uses AI. Check for mistakes.
forwardRef,
) {
const buttons = React.Children.map(children, (child, index) => <div key={index}>{child}</div>)
Expand All @@ -30,9 +27,9 @@ const ButtonGroup = React.forwardRef<HTMLElement, ButtonGroupProps>(function But
})

return (
<BoxWithFallback ref={buttonRef} className={clsx(className, classes.ButtonGroup)} role={role} {...rest}>
<BaseComponent ref={buttonRef} className={clsx(className, classes.ButtonGroup)} role={role} {...rest}>
{buttons}
</BoxWithFallback>
</BaseComponent>
)
}) as PolymorphicForwardRefComponent<'div', ButtonGroupProps>

Expand Down
Loading