UnderlineNav with updated design for states and counter #2277
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@primer/react': minor | ||
| --- | ||
|
|
||
| UnderlineNav.Link renamed to UnderlineNav.Item along with updated styles |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,8 @@ import {merge, SxProp, BetterSystemStyleObject} from '../sx' | |
| import {IconProps} from '@primer/octicons-react' | ||
| import {ForwardRefComponent as PolymorphicForwardRefComponent} from '../utils/polymorphic' | ||
| import {UnderlineNavContext} from './UnderlineNavContext' | ||
| import CounterLabel from '../CounterLabel' | ||
| import {Theme, useTheme} from '../ThemeProvider' | ||
|
|
||
| // adopted from React.AnchorHTMLAttributes | ||
| type LinkProps = { | ||
|
|
@@ -18,7 +20,7 @@ type LinkProps = { | |
| referrerPolicy?: React.AnchorHTMLAttributes<HTMLAnchorElement>['referrerPolicy'] | ||
| } | ||
|
|
||
| export type UnderlineNavItemProps = { | ||
| /** | ||
| * Primary content for an NavLink | ||
| */ | ||
|
|
@@ -36,16 +38,21 @@ export type UnderlineNavLinkProps = { | |
| */ | ||
| leadingIcon?: React.FunctionComponent<IconProps> | ||
| as?: React.ElementType | ||
| /** | ||
| * Counter | ||
| */ | ||
| counter?: number | ||
|
Contributor
There was a problem hiding this comment. @danielguillan - Wondering if we are going to support loading state for counters.
Member
Author
There was a problem hiding this comment. Just making a comment here for the types. I added the counter prop with only number type just to make the Counter component redundant. We can add another type for the loading state if we are going to support 😊
Contributor
There was a problem hiding this comment. Yes, we are going to support loading states. We can add support incrementally in another PR if that makes things easier. |
||
| } & SxProp & | ||
| LinkProps | ||
|
|
||
| export const UnderlineNavItem = forwardRef( | ||
| ( | ||
| { | ||
| sx: sxProp = {}, | ||
| as: Component = 'a', | ||
| href = '#', | ||
| children, | ||
| counter, | ||
| onSelect, | ||
| selected: preSelected = false, | ||
| leadingIcon: LeadingIcon, | ||
|
|
@@ -56,11 +63,13 @@ export const UnderlineNavLink = forwardRef( | |
| const backupRef = useRef<HTMLElement>(null) | ||
| const ref = forwardedRef ?? backupRef | ||
| const {setChildrenWidth, selectedLink, setSelectedLink, afterSelect, variant} = useContext(UnderlineNavContext) | ||
| const {theme} = useTheme() | ||
| useLayoutEffect(() => { | ||
| const domRect = (ref as MutableRefObject<HTMLElement>).current.getBoundingClientRect() | ||
| setChildrenWidth({width: domRect.width}) | ||
| preSelected && selectedLink === undefined && setSelectedLink(ref as RefObject<HTMLElement>) | ||
| }, [ref, preSelected, selectedLink, setSelectedLink, setChildrenWidth]) | ||
|
|
||
| const iconWrapStyles = { | ||
| alignItems: 'center', | ||
| display: 'inline-flex', | ||
|
|
@@ -70,29 +79,72 @@ export const UnderlineNavLink = forwardRef( | |
| const textStyles: BetterSystemStyleObject = { | ||
| whiteSpace: 'nowrap' | ||
| } | ||
|
|
||
| const wrapperStyles = { | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| display: 'inline-flex', | ||
| paddingY: 1, | ||
| paddingX: 2, | ||
| borderRadius: 2 | ||
| } | ||
| const smallVariantLinkStyles = { | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| paddingY: 1, | ||
| fontSize: 0 | ||
| } | ||
| const defaultVariantLinkStyles = { | ||
| paddingY: 2, | ||
| fontSize: 1 | ||
| } | ||
|
|
||
| // eslint-disable-next-line no-shadow | ||
| const linkStyles = (theme?: Theme) => ({ | ||
| position: 'relative', | ||
| display: 'inline-flex', | ||
| color: 'fg.default', | ||
| textAlign: 'center', | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| textDecoration: 'none', | ||
| paddingX: 1, | ||
| ...(variant === 'small' ? smallVariantLinkStyles : defaultVariantLinkStyles), | ||
| '&:hover > div[data-component="wrapper"] ': { | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| backgroundColor: theme?.colors.neutral.muted, | ||
| transition: 'background .12s ease-out' | ||
| }, | ||
| '&:focus': { | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| outline: 0, | ||
| '& > div[data-component="wrapper"]': { | ||
| boxShadow: `inset 0 0 0 2px ${theme?.colors.accent.fg}` | ||
| }, | ||
| // where focus-visible is supported, remove the focus box-shadow | ||
| '&:not(:focus-visible) > div[data-component="wrapper"]': { | ||
| boxShadow: 'none' | ||
| } | ||
| }, | ||
| '&:focus-visible > div[data-component="wrapper"]': { | ||
| boxShadow: `inset 0 0 0 2px ${theme?.colors.accent.fg}` | ||
| }, | ||
| // renders a visibly hidden "copy" of the label in bold, reserving box space for when label becomes bold on selected | ||
| '& span[data-content]::before': { | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| content: 'attr(data-content)', | ||
| display: 'block', | ||
| height: 0, | ||
| fontWeight: '600', | ||
| visibility: 'hidden' | ||
| }, | ||
| // selected state styles | ||
| '&::after': { | ||
broccolinisoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| position: 'absolute', | ||
| right: '50%', | ||
| bottom: 0, | ||
| width: `calc(100% - 8px)`, | ||
| height: 2, | ||
| content: '""', | ||
| bg: selectedLink === ref ? theme?.colors.primer.border.active : 'transparent', | ||
| borderRadius: 0, | ||
| transform: 'translate(50%, -50%)' | ||
| } | ||
| }) | ||
|
|
||
| const counterStyles = { | ||
| marginLeft: 2 | ||
| } | ||
| const keyPressHandler = React.useCallback( | ||
| event => { | ||
|
|
@@ -118,29 +170,41 @@ export const UnderlineNavLink = forwardRef( | |
| [onSelect, afterSelect, ref, setSelectedLink] | ||
| ) | ||
| return ( | ||
| <Box as="li" sx={{display: 'flex', flexDirection: 'column', alignItems: 'center'}}> | ||
| <Box | ||
| as={Component} | ||
| href={href} | ||
| onKeyPress={keyPressHandler} | ||
| onClick={clickHandler} | ||
| {...(selectedLink === ref ? {'aria-current': 'page'} : {})} | ||
| sx={merge(linkStyles(theme), sxProp as SxProp)} | ||
| {...props} | ||
| ref={ref} | ||
| > | ||
| <Box as="div" data-component="wrapper" sx={wrapperStyles}> | ||
| {LeadingIcon && ( | ||
| <Box as="span" data-component="leadingIcon" sx={iconWrapStyles}> | ||
| <LeadingIcon /> | ||
| </Box> | ||
| )} | ||
| {children && ( | ||
| <Box | ||
| as="span" | ||
| data-component="text" | ||
| data-content={children} | ||
| sx={selectedLink === ref ? {fontWeight: 600, ...{textStyles}} : {textStyles}} | ||
| > | ||
| {children} | ||
| </Box> | ||
| )} | ||
| {counter && ( | ||
| <Box as="span" data-component="counter" sx={counterStyles}> | ||
| <CounterLabel>{counter}</CounterLabel> | ||
| </Box> | ||
| )} | ||
| </Box> | ||
| </Box> | ||
| </Box> | ||
| ) | ||
| } | ||
| ) as PolymorphicForwardRefComponent<'a', UnderlineNavItemProps> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to fix extra margin around the button on safari
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wow, can you add a comment here about this?