Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/fluffy-moments-move.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': minor
---

Remove the CSS modules feature flag from the SideNav component
185 changes: 18 additions & 167 deletions packages/react/src/SideNav.tsx
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
import type {To} from 'history'
import styled, {css} from 'styled-components'

import Box from './Box'
import type {ComponentProps} from './utils/types'
import Link, {type LinkProps} from './Link'
import React, {type PropsWithChildren} from 'react'
import {clsx} from 'clsx'
import type {SxProp} from './sx'
import sx from './sx'
import {toggleStyledComponent} from './internal/utils/toggleStyledComponent'
import classes from './SideNav.module.css'
import {useFeatureFlag} from './FeatureFlags'

const CSS_MODULES_FEATURE_FLAG = 'primer_react_css_modules_ga'
import {toggleSxComponent} from './internal/utils/toggleSxComponent'
import {defaultSxProp} from './utils/defaultSxProp'

type SideNavBaseProps = {
as?: React.ElementType
Expand All @@ -23,63 +17,33 @@ type SideNavBaseProps = {
'aria-label'?: string
} & SxProp

const StyledNav = toggleStyledComponent(
CSS_MODULES_FEATURE_FLAG,
'nav',
styled(Box)<SideNavBaseProps>`
background-color: var(--bgColor-muted);

${props =>
props.bordered &&
css`
border-color: var(--borderColor-default);
border-style: solid;
border-width: var(--borderWidth-thin);
border-radius: var(--borderRadius-medium);

// Remove duplicate borders from nested SideNavs
& > & {
border-left: 0;
border-right: 0;
border-bottom: 0;
}
`}

${sx};
`,
)

function SideNav({
as = 'nav',
variant = 'normal',
className,
bordered,
children,
'aria-label': ariaLabel,
sx: sxProp,
sx: sxProp = defaultSxProp,
}: SideNavBaseProps) {
const enabled = useFeatureFlag(CSS_MODULES_FEATURE_FLAG)
const variantClassName = variant === 'lightweight' ? 'lightweight' : 'normal'
const newClassName = clsx(
classes.SideNav,
classes[`SideNavVariant--${variantClassName}`],
'sidenav',
`variant-${variantClassName}`,
className,
{
[classes.SideNav]: enabled,
[classes.SideNavBordered]: enabled && bordered,
[classes[`SideNavVariant--${variantClassName}`]]: enabled,
sidenav: !enabled,
[`variant-${variantClassName}`]: !enabled,
[classes.SideNavBordered]: bordered,
},
className,
)

const BaseComponent = toggleSxComponent(as) as React.ComponentType<SideNavBaseProps>

return (
<StyledNav
as={as}
bordered={enabled ? undefined : bordered}
className={newClassName}
aria-label={ariaLabel}
sx={sxProp}
>
<BaseComponent className={newClassName} aria-label={ariaLabel} sx={sxProp}>
{children}
</StyledNav>
</BaseComponent>
)
}

Expand All @@ -90,134 +54,21 @@ type StyledSideNavLinkProps = PropsWithChildren<{
}> &
LinkProps

// used for variant normal hover, focus pseudo selectors
const CommonAccessibilityVariantNormalStyles = css`
background-color: var(--bgColor-neutral-muted);
text-decoration: none;
`

// used for light weight hover, focus pseudo selectors
const CommonAccessibilityVariantLightWeightStyles = css`
color: var(--fgColor-default);
text-decoration: none;
`

const StyledSideNavLink = toggleStyledComponent(
CSS_MODULES_FEATURE_FLAG,
Link,
styled(Link)<StyledSideNavLinkProps & SxProp>`
position: relative;
display: block;
width: 100%;
font-size: 14px;
text-align: left;
text-decoration: none;
${props =>
props.variant === 'full' &&
css`
display: flex;
align-items: center;
justify-content: space-between;
`}

& > .sidenav {
border-bottom: none;
}

.sidenav.variant-normal > & {
color: var(--fgColor-default);
padding: var(--base-size-16);
border: 0;
border-top: var(--borderWidth-thin) solid var(--borderColor-muted);

&:first-child {
border-top: 0;
border-top-right-radius: var(--borderRadius-medium);
border-top-left-radius: var(--borderRadius-medium);
}

&:last-child {
border-bottom-right-radius: var(--borderRadius-medium);
border-bottom-left-radius: var(--borderRadius-medium);
}

// Bar on the left
&::before {
position: absolute;
top: 0;
bottom: 0;
left: 0;
z-index: 1;
width: 3px;
pointer-events: none;
content: '';
}

&:hover {
${CommonAccessibilityVariantNormalStyles}
}

&:focus {
${CommonAccessibilityVariantNormalStyles}
outline: solid 2px var(--fgColor-accent);
z-index: 1;
}

&[aria-current='page'],
&[aria-selected='true'] {
background-color: var(--bgColor-default);

// Bar on the left
&::before {
background-color: var(--underlineNav-borderColor-active, var(--color-primer-border-active, #fd8c73));
}
}
}

.sidenav.variant-lightweight > & {
padding: var(--base-size-4) 0;
color: var(--fgColor-accent);

&:hover {
${CommonAccessibilityVariantLightWeightStyles}
}

&:focus {
${CommonAccessibilityVariantLightWeightStyles}
outline: solid 1px var(--fgColor-accent);
z-index: 1;
}

&[aria-current='page'],
&[aria-selected='true'] {
color: var(--fgColor-default);
font-weight: var(--base-text-weight-medium);
}
}

${sx};
`,
)

const SideNavLink = ({selected, to, variant, className, children, ...rest}: StyledSideNavLinkProps) => {
const isReactRouter = typeof to === 'string'
const enabled = useFeatureFlag(CSS_MODULES_FEATURE_FLAG)
const newClassName = clsx(
{[classes.SideNavLink]: true, [classes.SideNavLinkFull]: enabled && variant === 'full'},
className,
)

const newClassName = clsx(classes.SideNavLink, className, {[classes.SideNavLinkFull]: variant === 'full'})
const BaseComponent = toggleSxComponent(Link) as React.ComponentType<StyledSideNavLinkProps>
// according to their docs, NavLink supports aria-current:
// https://reacttraining.com/react-router/web/api/NavLink/aria-current-string
return (
<StyledSideNavLink
<BaseComponent
aria-current={isReactRouter || selected ? 'page' : undefined}
className={newClassName}
variant={variant}
{...rest}
>
{children}
</StyledSideNavLink>
</BaseComponent>
)
}

Expand Down
Loading