Skip to content
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.

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

feat(InlineMessage): Convert InlineMessage component to CSS Modules behind feature flag #5204

Merged
merged 12 commits into from
Nov 5, 2024
5 changes: 5 additions & 0 deletions .changeset/silent-cherries-behave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": minor
---

Migrate 'InlineMessage' component to use CSS modules
18 changes: 18 additions & 0 deletions packages/react/src/InlineMessage/InlineMessage.dev.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import type {Meta} from '@storybook/react'
import React from 'react'
import {InlineMessage} from '.'

const meta = {
title: 'Experimental/Components/InlineMessage/Dev',
component: InlineMessage,
} satisfies Meta<typeof InlineMessage>

export default meta

export const Default = () => {
randall-krauskopf marked this conversation as resolved.
Show resolved Hide resolved
return (
<InlineMessage variant="unavailable" sx={{color: 'red'}}>
An example inline message
</InlineMessage>
)
}
42 changes: 42 additions & 0 deletions packages/react/src/InlineMessage/InlineMessage.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.InlineMessage {
display: grid;
/* stylelint-disable-next-line primer/typography */
font-size: var(--inline-message-fontSize);
/* stylelint-disable-next-line primer/typography */
line-height: var(--inline-message-lineHeight);
/* stylelint-disable-next-line primer/colors */
color: var(--inline-message-fgColor);
column-gap: 0.5rem;
grid-template-columns: auto 1fr;
align-items: start;

&[data-size='small'] {
--inline-message-fontSize: var(--text-body-size-small);
--inline-message-lineHeight: var(--text-body-lineHeight-small, 1.6666);
}

&[data-size='medium'] {
--inline-message-fontSize: var(--text-body-size-medium);
--inline-message-lineHeight: var(--text-body-lineHeight-medium, 1.4285);
}

&[data-variant='warning'] {
--inline-message-fgColor: var(--fgColor-attention);
}

&[data-variant='critical'] {
--inline-message-fgColor: var(--fgColor-danger);
}

&[data-variant='success'] {
--inline-message-fgColor: var(--fgColor-success);
}

&[data-variant='unavailable'] {
--inline-message-fgColor: var(--fgColor-muted);
}
}

.InlineMessageIcon {
min-height: calc(var(--inline-message-lineHeight) * var(--inline-message-fontSize)) !important;
}
130 changes: 78 additions & 52 deletions packages/react/src/InlineMessage/InlineMessage.tsx
Original file line number Diff line number Diff line change
@@ -1,78 +1,104 @@
import {AlertFillIcon, AlertIcon, CheckCircleFillIcon, CheckCircleIcon} from '@primer/octicons-react'
import {clsx} from 'clsx'
import React from 'react'
import styled from 'styled-components'
import {get} from '../constants'

import {toggleStyledComponent} from '../internal/utils/toggleStyledComponent'
import {useFeatureFlag} from '../FeatureFlags'
import classes from './InlineMessage.module.css'
import type {SxProp} from '../sx'
type MessageVariant = 'critical' | 'success' | 'unavailable' | 'warning'

export type InlineMessageProps = React.ComponentPropsWithoutRef<'div'> & {
/**
* Specify the size of the InlineMessage
*/
size?: 'small' | 'medium'

/**
* Specify the type of the InlineMessage
*/
variant: MessageVariant
}
const CSS_MODULES_FEATURE_FLAG = 'primer_react_css_modules_team'

const StyledMessage = styled.div`
display: grid;
column-gap: 0.5rem;
grid-template-columns: auto 1fr;
align-items: start;
color: var(--inline-message-fgColor, ${get('colors.fg.muted')});
line-height: var(--inline-message-lineHeight);
font-size: var(--inline-message-fontSize, ${get('fontSizes.1')});
export type InlineMessageProps = React.ComponentPropsWithoutRef<'div'> &
SxProp & {
/**
* Specify the size of the InlineMessage
*/
size?: 'small' | 'medium'

&[data-size='small'] {
--inline-message-fontSize: var(--text-body-size-small, ${get('fontSizes.0')});
--inline-message-lineHeight: var(--text-body-lineHeight-small, 1.6666);
/**
* Specify the type of the InlineMessage
*/
variant: MessageVariant
}

&[data-size='medium'] {
--inline-message-fontSize: var(--text-body-size-medium, ${get('fontSizes.1')});
--inline-message-lineHeight: var(--text-body-lineHeight-medium, 1.4285);
}
const StyledMessage = toggleStyledComponent(
CSS_MODULES_FEATURE_FLAG,
'div',
styled.div`
display: grid;
column-gap: 0.5rem;
grid-template-columns: auto 1fr;
align-items: start;
color: var(--inline-message-fgColor, ${get('colors.fg.muted')});
line-height: var(--inline-message-lineHeight);
font-size: var(--inline-message-fontSize, ${get('fontSizes.1')});

&[data-variant='warning'] {
--inline-message-fgColor: ${get('colors.attention.fg')};
}
&[data-size='small'] {
--inline-message-fontSize: var(--text-body-size-small, ${get('fontSizes.0')});
--inline-message-lineHeight: var(--text-body-lineHeight-small, 1.6666);
}

&[data-variant='critical'] {
--inline-message-fgColor: ${get('colors.danger.fg')};
}
&[data-size='medium'] {
--inline-message-fontSize: var(--text-body-size-medium, ${get('fontSizes.1')});
--inline-message-lineHeight: var(--text-body-lineHeight-medium, 1.4285);
}

&[data-variant='success'] {
--inline-message-fgColor: ${get('colors.success.fg')};
}
&[data-variant='warning'] {
--inline-message-fgColor: ${get('colors.attention.fg')};
}

&[data-variant='unavailable'] {
--inline-message-fgColor: ${get('colors.fg.muted')};
}
&[data-variant='critical'] {
--inline-message-fgColor: ${get('colors.danger.fg')};
}

& .InlineMessageIcon {
min-height: calc(var(--inline-message-lineHeight) * var(--inline-message-fontSize));
}
`
&[data-variant='success'] {
--inline-message-fgColor: ${get('colors.success.fg')};
}

&[data-variant='unavailable'] {
--inline-message-fgColor: ${get('colors.fg.muted')};
}

& .InlineMessageIcon {
min-height: calc(var(--inline-message-lineHeight) * var(--inline-message-fontSize));
}
`,
)

const variantToIcon: Record<MessageVariant, React.ReactNode> = {
warning: <AlertIcon className="InlineMessageIcon" />,
critical: <AlertIcon className="InlineMessageIcon" />,
success: <CheckCircleIcon className="InlineMessageIcon" />,
unavailable: <AlertIcon className="InlineMessageIcon" />,
warning: <AlertIcon className={classes.InlineMessageIcon} />,
critical: <AlertIcon className={classes.InlineMessageIcon} />,
success: <CheckCircleIcon className={classes.InlineMessageIcon} />,
unavailable: <AlertIcon className={classes.InlineMessageIcon} />,
}

const variantToSmallIcon: Record<MessageVariant, React.ReactNode> = {
warning: <AlertFillIcon className="InlineMessageIcon" size={12} />,
critical: <AlertFillIcon className="InlineMessageIcon" size={12} />,
success: <CheckCircleFillIcon className="InlineMessageIcon" size={12} />,
unavailable: <AlertFillIcon className="InlineMessageIcon" size={12} />,
warning: <AlertFillIcon className={classes.InlineMessageIcon} size={12} />,
critical: <AlertFillIcon className={classes.InlineMessageIcon} size={12} />,
success: <CheckCircleFillIcon className={classes.InlineMessageIcon} size={12} />,
unavailable: <AlertFillIcon className={classes.InlineMessageIcon} size={12} />,
randall-krauskopf marked this conversation as resolved.
Show resolved Hide resolved
}

export function InlineMessage({children, size = 'medium', variant, ...rest}: InlineMessageProps) {
export function InlineMessage({children, className, size = 'medium', variant, ...rest}: InlineMessageProps) {
const enabled = useFeatureFlag(CSS_MODULES_FEATURE_FLAG)

const icon = size === 'small' ? variantToSmallIcon[variant] : variantToIcon[variant]
if (enabled) {
return (
<StyledMessage
className={clsx(classes.InlineMessage, className)}
{...rest}
data-size={size}
data-variant={variant}
>
{icon}
{children}
</StyledMessage>
)
}
randall-krauskopf marked this conversation as resolved.
Show resolved Hide resolved
return (
<StyledMessage {...rest} data-size={size} data-variant={variant}>
{icon}
Expand Down
Loading