Skip to content

Remove sx props and Box from Truncate #6632

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 8 commits into from
Aug 26, 2025
Merged

Remove sx props and Box from Truncate #6632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
944a526
remove sx props and Box from Truncate
liuliu-dev Aug 20, 2025
7581279
changeset
liuliu-dev Aug 20, 2025
b73a06a
update Truncate usage in Description
liuliu-dev Aug 20, 2025
db5b5e9
conflicts
liuliu-dev Aug 25, 2025
1e128b3
conflicts
liuliu-dev Aug 26, 2025
978f009
lint
liuliu-dev Aug 26, 2025
299d8cc
update maxWith type to match MaxWidthProps from styled-system
liuliu-dev Aug 26, 2025
a5bd7a9
Merge branch 'main' into liuliu/migrate-truncate
liuliu-dev Aug 26, 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/lucky-facts-obey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@primer/react': major
'@primer/styled-react': patch
---

Update Truncate component to no longer support sx, add sx wrapper to @primer/styled-react.
1 change: 0 additions & 1 deletion packages/react/src/ActionList/Description.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ export const Description: React.FC<React.PropsWithChildren<ActionListDescription
ref={containerRef}
id={inlineDescriptionId}
className={clsx(className, classes.Description)}
sx={sx}
title={effectiveTitle}
inline={true}
maxWidth="100%"
Expand Down
7 changes: 1 addition & 6 deletions packages/react/src/Truncate/Truncate.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"props": [
{
"name": "maxWidth",
"type": "number",
"type": "number | string | (number | string)[]",
"defaultValue": "125",
"description": "Sets the max-width of the text."
},
Expand All @@ -41,11 +41,6 @@
"name": "as",
"type": "React.ElementType",
"defaultValue": "'div'"
},
{
"name": "sx",
"type": "SystemStyleObject",
"deprecated": true
}
],
"subcomponents": []
Expand Down
6 changes: 0 additions & 6 deletions packages/react/src/Truncate/Truncate.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,6 @@ Playground.argTypes = {
disable: true,
},
},
sx: {
controls: false,
table: {
disable: true,
},
},
theme: {
controls: false,
table: {
Expand Down
15 changes: 5 additions & 10 deletions packages/react/src/Truncate/Truncate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
import React from 'react'
import {clsx} from 'clsx'
import type {MaxWidthProps} from 'styled-system'
import type {SxProp} from '../sx'
import type {ForwardRefComponent as PolymorphicForwardRefComponent} from '../utils/polymorphic'
import {BoxWithFallback} from '../internal/components/BoxWithFallback'
import classes from './Truncate.module.css'

type TruncateProps = React.HTMLAttributes<HTMLElement> & {
title: string
inline?: boolean
expandable?: boolean
} & MaxWidthProps &
SxProp
maxWidth?: number | string | (number | string)[]
}

const Truncate = React.forwardRef(function Truncate(
{as, children, className, title, inline, expandable, maxWidth = 125, style, sx, ...rest},
{as: Component = 'div', children, className, title, inline, expandable, maxWidth = 125, style, ...rest},
ref,
) {
return (
<BoxWithFallback
<Component
{...rest}
ref={ref}
as={as}
className={clsx(className, classes.Truncate)}
data-expandable={expandable}
data-inline={inline}
Expand All @@ -33,10 +29,9 @@ const Truncate = React.forwardRef(function Truncate(
typeof maxWidth === 'number' ? `${maxWidth}px` : typeof maxWidth === 'string' ? maxWidth : undefined,
} as React.CSSProperties
}
sx={sx}
>
{children}
</BoxWithFallback>
</Component>
)
}) as PolymorphicForwardRefComponent<'div', TruncateProps>

Expand Down
2 changes: 1 addition & 1 deletion packages/styled-react/src/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
exports[`@primer/styled-react exports 1`] = `
[
"ToggleSwitch",
"Truncate",
"ActionList",
"ActionMenu",
"Autocomplete",
Expand Down Expand Up @@ -49,7 +50,6 @@ exports[`@primer/styled-react exports 1`] = `
"Timeline",
"Token",
"Tooltip",
"Truncate",
"UnderlineNav",
"Box",
"sx",
Expand Down
6 changes: 3 additions & 3 deletions packages/styled-react/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import {ToggleSwitch as PrimerToggleSwitch} from '@primer/react'
import {Truncate as PrimerTruncate, ToggleSwitch as PrimerToggleSwitch} from '@primer/react'
import {createStyledComponent} from './utils/createStyledComponent'

const Truncate: ReturnType<typeof createStyledComponent> = /*#__PURE__*/ createStyledComponent(PrimerTruncate)
const ToggleSwitch: ReturnType<typeof createStyledComponent> = /*#__PURE__*/ createStyledComponent(PrimerToggleSwitch)
export {ToggleSwitch}
export {ToggleSwitch, Truncate}

export {
ActionList,
Expand Down Expand Up @@ -51,7 +52,6 @@ export {
Timeline,
Token,
Tooltip,
Truncate,
UnderlineNav,

// styled-components components or types
Expand Down
Loading