Skip to content

Remove support for sx from Details component #6680

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

Remove support for sx from Details component #6680

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
170ccc0
remove sx support from Details.tsx
llastflowers Aug 27, 2025
9edba13
delete Details.dev.stories.tsx because there was only one story and i…
llastflowers Aug 27, 2025
5b9a818
remove sx from docs
llastflowers Aug 27, 2025
6e0c61e
remove sx from e2e
llastflowers Aug 27, 2025
cdc76f6
Update Details component to remove sx support
llastflowers Aug 27, 2025
0d4f6a3
Merge branch 'main' into llastflowers/5784/no-sc-Details
llastflowers Sep 5, 2025
b1474a2
Merge branch 'main' into llastflowers/5784/no-sc-Details
llastflowers Sep 5, 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/strange-knives-study.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': major
---

Update Details component to no longer support sx
4 changes: 0 additions & 4 deletions e2e/components/Details.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ const stories: Array<{title: string; id: string}> = [
title: 'Default',
id: 'components-details--default',
},
{
title: 'SX Prop Stress Test',
id: 'components-details-dev--sx-prop-stress-test',
},
]

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

This file was deleted.

13 changes: 1 addition & 12 deletions packages/react/src/Details/Details.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,7 @@
}
],
"importPath": "@primer/react",
"props": [
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
],
"props": [],
"subcomponents": [
{
"name": "Details.Summary",
Expand All @@ -30,11 +24,6 @@
{
"name": "children",
"type": "React.ReactNode"
},
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
]
}
Expand Down
8 changes: 3 additions & 5 deletions packages/react/src/Details/Details.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
import React, {useEffect, useState, type ComponentPropsWithoutRef, type ReactElement} from 'react'
import type {SxProp} from '../sx'
import {clsx} from 'clsx'
import classes from './Details.module.css'
import {useMergedRefs} from '../internal/hooks/useMergedRefs'
import {BoxWithFallback} from '../internal/components/BoxWithFallback'

const Root = React.forwardRef<HTMLDetailsElement, DetailsProps>(
({className, children, ...rest}, forwardRef): ReactElement => {
Expand Down Expand Up @@ -40,11 +38,11 @@ const Root = React.forwardRef<HTMLDetailsElement, DetailsProps>(
}, [])

return (
<BoxWithFallback as="details" className={clsx(className, classes.Details)} {...rest} ref={ref}>
<details className={clsx(className, classes.Details)} {...rest} ref={ref}>
{/* Include default summary if summary is not provided */}
{!hasSummary && <Details.Summary data-default-summary>{'See Details'}</Details.Summary>}
{children}
</BoxWithFallback>
</details>
)
},
)
Expand Down Expand Up @@ -75,5 +73,5 @@ const Details = Object.assign(Root, {
Summary,
})

export type DetailsProps = ComponentPropsWithoutRef<'details'> & SxProp
export type DetailsProps = ComponentPropsWithoutRef<'details'>
export default Details
Loading