Skip to content

refactor(Flash): update sx usage to CSS Modules #6007

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
joshblack merged 3 commits into from
May 6, 2025
Merged

refactor(Flash): update sx usage to CSS Modules #6007

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e74cfc3
refactor(Flash): update sx usage to CSS Modules
joshblack May 5, 2025
b0aa48a
test: update tests
joshblack May 5, 2025
85067e1
fix: stylelint errors
joshblack May 6, 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/giant-bushes-matter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': minor
---

Update Flash from sx to CSS Modules
59 changes: 59 additions & 0 deletions packages/react/src/Flash/Flash.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.Flash {
position: relative;
color: var(--fgColor-default);
padding: var(--base-size-16);
border-style: solid;
border-width: 1px;
border-radius: var(--borderRadius-medium);
margin-top: 0;

&:where([data-variant='default']) {
background-color: var(--bgColor-accent-muted);
Comment thread
joshblack marked this conversation as resolved.
border-color: var(--borderColor-accent-muted);

& :where(svg) {
color: var(--fgColor-accent);
}
}

&:where([data-variant='success']) {
background-color: var(--bgColor-success-muted);
Comment thread
joshblack marked this conversation as resolved.
border-color: var(--borderColor-success-muted);

& :where(svg) {
color: var(--fgColor-success);
}
}

&:where([data-variant='danger']) {
background-color: var(--bgColor-danger-muted);
Comment thread
joshblack marked this conversation as resolved.
border-color: var(--borderColor-danger-muted);

& :where(svg) {
color: var(--fgColor-danger);
}
}

&:where([data-variant='warning']) {
background-color: var(--bgColor-attention-muted);
Comment thread
joshblack marked this conversation as resolved.
border-color: var(--borderColor-attention-muted);

& :where(svg) {
color: var(--fgColor-attention);
}
}

&:where([data-full]) {
border-width: 1px 0px;
border-radius: 0;
margin-top: -1px;
}

& :where(p:last-child) {
margin-bottom: 0;
}

& :where(svg) {
margin-right: var(--base-size-8);
}
}
87 changes: 18 additions & 69 deletions packages/react/src/Flash/Flash.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,80 +1,29 @@
import {clsx} from 'clsx'
import React from 'react'
import styled from 'styled-components'
import {variant} from 'styled-system'
import {get} from '../constants'
import type {SxProp} from '../sx'
import sx from '../sx'
import type {ComponentProps} from '../utils/types'
import type {ForwardRefComponent as PolymorphicForwardRefComponent} from '../utils/polymorphic'
import {BoxWithFallback} from '../internal/components/BoxWithFallback'
import classes from './Flash.module.css'

const variants = variant({
variants: {
default: {
color: 'fg.default',
backgroundColor: 'accent.subtle',
borderColor: 'accent.muted',
svg: {
color: 'accent.fg',
},
},
success: {
color: 'fg.default',
backgroundColor: 'success.subtle',
borderColor: 'success.muted',
svg: {
color: 'success.fg',
},
},
danger: {
color: 'fg.default',
backgroundColor: 'danger.subtle',
borderColor: 'danger.muted',
svg: {
color: 'danger.fg',
},
},
warning: {
color: 'fg.default',
backgroundColor: 'attention.subtle',
borderColor: 'attention.muted',
svg: {
color: 'attention.fg',
},
},
},
})

type StyledFlashProps = {
export type FlashProps = React.ComponentPropsWithoutRef<'div'> & {
className?: string
variant?: 'default' | 'warning' | 'success' | 'danger'
full?: boolean
} & SxProp

const StyledFlash = styled.div<StyledFlashProps>`
position: relative;
color: ${get('colors.fg.default')};
padding: ${get('space.3')};
border-style: solid;
border-width: ${props => (props.full ? '1px 0px' : '1px')};
border-radius: ${props => (props.full ? '0' : get('radii.2'))};
margin-top: ${props => (props.full ? '-1px' : '0')};

p:last-child {
margin-bottom: 0;
}

svg {
margin-right: ${get('space.2')};
}

${variants};
${sx};
`

export type FlashProps = ComponentProps<typeof StyledFlash>

const Flash = React.forwardRef(function Flash({as, variant = 'default', ...rest}, ref) {
return <StyledFlash ref={ref} as={as} variant={variant} {...rest} />
}) as PolymorphicForwardRefComponent<'div', StyledFlashProps>
const Flash = React.forwardRef(function Flash({as, className, variant = 'default', full, sx, ...rest}, ref) {
return (
<BoxWithFallback
{...rest}
ref={ref}
as={as}
className={clsx(classes.Flash, className)}
data-full={full ? '' : undefined}
data-variant={variant}
sx={sx}
/>
)
}) as PolymorphicForwardRefComponent<'div', FlashProps>

if (__DEV__) {
Flash.displayName = 'Flash'
Expand Down