Skip to content

Remove support for sx from LabelGroup component #6682

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

Remove support for sx from LabelGroup component #6682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8fb16a
remove sx support from LabelGroup.tsx
llastflowers Aug 27, 2025
da0bd77
Update LabelGroup to remove sx support
llastflowers Aug 27, 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
6 changes: 6 additions & 0 deletions .changeset/seven-coats-hang.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

---
'@primer/react': major
---

Update LabelGroup component to no longer support sx
29 changes: 7 additions & 22 deletions packages/react/src/LabelGroup/LabelGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,8 @@ import {getFocusableChild} from '@primer/behaviors/utils'
import {get} from '../constants'
import VisuallyHidden from '../_VisuallyHidden'
import {AnchoredOverlay} from '../AnchoredOverlay'
import Box from '../Box'
import {Button, IconButton} from '../Button'
import {useTheme} from '../ThemeProvider'
import type {SxProp} from '../sx'
import sx from '../sx'

export type LabelGroupProps = {
/** Customize the element type of the rendered container */
Expand All @@ -19,9 +16,9 @@ export type LabelGroupProps = {
/** How many tokens to show. `'auto'` truncates the tokens to fit in the parent container. Passing a number will truncate after that number tokens. If this is undefined, tokens will never be truncated. */
visibleChildCount?: 'auto' | number
className?: string
} & SxProp
}

const StyledLabelGroupContainer = styled.div<SxProp>`
const StyledLabelGroupContainer = styled.div`
display: flex;
flex-wrap: nowrap;
gap: ${get('space.1')};
Expand All @@ -39,8 +36,6 @@ const StyledLabelGroupContainer = styled.div<SxProp>`
margin-block-end: 0;
list-style-type: none;
}

${sx};
`

const ItemWrapper = styled.div`
Expand Down Expand Up @@ -137,18 +132,16 @@ const OverlayToggle: React.FC<
)}
focusZoneSettings={{disabled: true}}
>
<Box alignItems="flex-start" display="flex" width={overlayWidth} padding={`${overlayPaddingPx}px`}>
<Box display="flex" flexWrap="wrap" sx={{gap: 1}}>
{children}
</Box>
<div style={{alignItems: 'flex-start', display: 'flex', width: overlayWidth, padding: `${overlayPaddingPx}px`}}>
<div style={{display: 'flex', flexWrap: 'wrap', gap: '4px'}}>{children}</div>
<IconButton
onClick={closeOverflowOverlay}
icon={XIcon}
aria-label="Close"
variant="invisible"
sx={{flexShrink: 0}}
style={{flexShrink: 0}}
/>
</Box>
</div>
</AnchoredOverlay>
) : null

Expand All @@ -157,7 +150,6 @@ const LabelGroup: React.FC<React.PropsWithChildren<LabelGroupProps>> = ({
children,
visibleChildCount,
overflowStyle = 'overlay',
sx: sxProp,
as = 'ul',
className,
}) => {
Expand Down Expand Up @@ -338,7 +330,6 @@ const LabelGroup: React.FC<React.PropsWithChildren<LabelGroupProps>> = ({
ref={containerRef}
data-overflow={overflowStyle === 'inline' && isOverflowShown ? 'inline' : undefined}
data-list={isList || undefined}
sx={sxProp}
className={className}
as={as}
>
Expand Down Expand Up @@ -381,13 +372,7 @@ const LabelGroup: React.FC<React.PropsWithChildren<LabelGroupProps>> = ({
</ToggleWrapper>
</StyledLabelGroupContainer>
) : (
<StyledLabelGroupContainer
data-overflow="inline"
data-list={isList || undefined}
sx={sxProp}
as={as}
className={className}
>
<StyledLabelGroupContainer data-overflow="inline" data-list={isList || undefined} as={as} className={className}>
{isList
? React.Children.map(children, (child, index) => {
return <li key={index}>{child}</li>
Expand Down
Loading