Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
a3b34ca
feat: remove sx prop from Label
joshblack Aug 19, 2025
f15d115
chore: add changeset
joshblack Aug 19, 2025
b1877c2
feat(styled-react): update how components are re-exported
joshblack Aug 20, 2025
d00461f
chore: add ts-expect-error for box
joshblack Aug 21, 2025
1098eb2
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
joshblack Sep 2, 2025
b479d38
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
joshblack Sep 4, 2025
09f6cf6
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
joshblack Sep 4, 2025
34086e8
chore: update snapshots
joshblack Sep 4, 2025
2ee107c
chore: fix lint errors
joshblack Sep 4, 2025
ce27af7
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
joshblack Sep 12, 2025
fe08048
test: update snapshots
joshblack Sep 12, 2025
d5ffdcb
chore: update eslint config
joshblack Sep 12, 2025
61cc46a
Merge branch 'main' into feat/remove-sx-from-label-2
mperrotti Sep 15, 2025
c11c563
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
mperrotti Sep 16, 2025
8f0571f
Merge branch 'main' into feat/remove-sx-from-label-2
jonrohan Sep 22, 2025
18fcb29
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
mperrotti Sep 24, 2025
59c0934
Merge branch 'main' of github.com:primer/react into feat/remove-sx-fr…
francinelucca Sep 29, 2025
e517b18
add label export
francinelucca Sep 29, 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/good-snakes-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': major
---

Remove the sx prop from Label
20 changes: 0 additions & 20 deletions packages/react/src/Label/Label.dev.stories.tsx

This file was deleted.

6 changes: 0 additions & 6 deletions packages/react/src/Label/Label.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,6 @@ Playground.argTypes = {
disable: true,
},
},
sx: {
control: false,
table: {
disable: true,
},
},
}

export const Default = () => <Label>Default</Label>
63 changes: 5 additions & 58 deletions packages/react/src/Label/Label.tsx
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
// TODO: merge https://github.com/primer/react/pull/6631 which removes `Box` usage

import {clsx} from 'clsx'
import Box from '../Box'
import classes from './Label.module.css'
import React from 'react'
import type {BetterSystemStyleObject, SxProp} from '../sx'
import type {ForwardRefComponent as PolymorphicForwardRefComponent} from '../utils/polymorphic'

export type LabelProps = {
/** The color of the label */
variant?: LabelColorOptions
/** How large the label is rendered */
size?: LabelSizeKeys
} & SxProp
}

export type LabelColorOptions =
| 'default'
Expand All @@ -28,61 +26,10 @@ export type LabelColorOptions =

type LabelSizeKeys = 'small' | 'large'

export const variants: Record<LabelColorOptions, BetterSystemStyleObject> = {
default: {
borderColor: 'border.default',
},
primary: {
borderColor: 'fg.default',
},
secondary: {
borderColor: 'border.muted',
color: 'fg.muted',
},
accent: {
borderColor: 'accent.emphasis',
color: 'accent.fg',
},
success: {
borderColor: 'success.emphasis',
color: 'success.fg',
},
attention: {
borderColor: 'attention.emphasis',
color: 'attention.fg',
},
severe: {
borderColor: 'severe.emphasis',
color: 'severe.fg',
},
danger: {
borderColor: 'danger.emphasis',
color: 'danger.fg',
},
done: {
borderColor: 'done.emphasis',
color: 'done.fg',
},
sponsors: {
borderColor: 'sponsors.emphasis',
color: 'sponsors.fg',
},
}

const Label = React.forwardRef(function Label({as, size = 'small', variant = 'default', className, ...rest}, ref) {
const Component = as || 'span'
if (rest.sx) {
return (
<Box
as={Component}
className={clsx(className, classes.Label)}
data-size={size}
data-variant={variant}
ref={ref}
{...rest}
/>
)
}
const Label = React.forwardRef(function Label(
{as: Component = 'span', size = 'small', variant = 'default', className, ...rest},
ref,
) {
return (
<Component className={clsx(className, classes.Label)} data-size={size} data-variant={variant} ref={ref} {...rest} />
)
Expand Down
1 change: 0 additions & 1 deletion packages/react/src/Label/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import Label from './Label'
export type {LabelProps, LabelColorOptions} from './Label'
export {variants} from './Label'
export default Label
12 changes: 12 additions & 0 deletions packages/styled-react/src/components/Label.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import {type LabelProps as PrimerLabelProps, Label as PrimerLabel, Box} from '@primer/react'
import {type SxProp} from '../sx'
import {forwardRef} from 'react'
import type {ForwardRefComponent} from '../polymorphic'

type LabelProps = PrimerLabelProps & SxProp

const Label = forwardRef(function Label(props, ref) {
return <Box as={PrimerLabel} ref={ref} {...props} />
}) as ForwardRefComponent<'span', LabelProps>

export {Label, type LabelProps}
2 changes: 1 addition & 1 deletion packages/styled-react/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ export {Button} from '@primer/react'
export {CheckboxGroup} from '@primer/react'
export {Details} from '@primer/react'
export {IconButton} from '@primer/react'
export {Label} from '@primer/react'
export {ProgressBar} from '@primer/react'
export {Select} from '@primer/react'
export {Text} from '@primer/react'
Expand Down Expand Up @@ -35,6 +34,7 @@ export {Flash} from './components/Flash'
export {FormControl, type FormControlProps} from './components/FormControl'
export {Header, type HeaderProps} from './components/Header'
export {Heading} from './components/Heading'
export {Label, type LabelProps} from './components/Label'
export {Link, type LinkProps} from './components/Link'
export {LinkButton, type LinkButtonProps} from './components/LinkButton'
export {NavList, type NavListProps} from './components/NavList'
Expand Down
Loading