Skip to content

Bug Fix for Text component and styled system arguments #5079

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
jonrohan merged 5 commits into from
Oct 7, 2024
Merged

Bug Fix for Text component and styled system arguments #5079

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c1894f7
Fix for Text component and styled system arguments
jonrohan Oct 7, 2024
585fe5a
Create wet-apples-hide.md
jonrohan Oct 7, 2024
3781b2c
Update packages/react/src/Text/Text.tsx
jonrohan Oct 7, 2024
e5e7118
Remove semicolons and fix logical operator
jonrohan Oct 7, 2024
e247b44
Remove semicolon in includesSystemProps function
jonrohan Oct 7, 2024
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/wet-apples-hide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": patch
---

Correctly pass styled system typography and common props to the `Box` component in the `Text` component when the CSS modules feature flag is enabled.
13 changes: 9 additions & 4 deletions packages/react/src/Text/Text.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,21 @@ const StyledText = styled.span<StyledTextProps>`
${sx};
`

const includesSystemProps = (props: StyledTextProps) => {
return (
props.sx ||
Object.keys(props).some(prop => Object.keys(TYPOGRAPHY).includes(prop) || Object.keys(COMMON).includes(prop))
)
}
Comment thread
jonrohan marked this conversation as resolved.

const Text = forwardRef(({as: Component = 'span', className, size, weight, ...props}, forwardedRef) => {
const enabled = useFeatureFlag('primer_react_css_modules_ga')

const innerRef = React.useRef<HTMLElement>(null)
useRefObjectAsForwardedRef(forwardedRef, innerRef)

if (enabled) {
if (props.sx) {
// If props includes TYPOGRAPHY or COMMON props, pass them to the Box component
if (includesSystemProps(props)) {
return (
// @ts-ignore shh
<Box
Expand All @@ -81,7 +88,6 @@ const Text = forwardRef(({as: Component = 'span', className, size, weight, ...pr
}

return (
// @ts-ignore shh
<Component
className={clsx(className, classes.Text)}
data-size={size}
Expand All @@ -94,7 +100,6 @@ const Text = forwardRef(({as: Component = 'span', className, size, weight, ...pr
}

return (
// @ts-ignore shh
<StyledText
as={Component}
className={className}
Expand Down