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.

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

Jump to bottom

fix: Split <Item> labels #1320

Merged
merged 7 commits into from
Jun 25, 2021
Merged

fix: Split <Item> labels #1320

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
09970b8
fix: Separate 'Item' content into 'label' and 'description'
smockle Jun 18, 2021
0229d93
fix: Only add 'aria-describedby' when 'description' exists
smockle Jun 18, 2021
f38b828
fix: Memoize 'id' so 'Item's and labels match
smockle Jun 18, 2021
254a4a3
fix: Don’t rely on 'id' which is possibly not globally-unique
smockle Jun 24, 2021
408ff24
fix: Restore semi-full-width 'Item' dividers, without giving up the s…
smockle Jun 25, 2021
73eed06
fix: Reduce styled-components class permutations.
smockle Jun 25, 2021
5002b7b
Merge branch 'main' into item-label-description
smockle Jun 25, 2021
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
134 changes: 74 additions & 60 deletions src/ActionList/Item.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {CheckIcon, IconProps} from '@primer/octicons-react'
import React, {useCallback} from 'react'
import React, {useCallback, useMemo} from 'react'
import {get} from '../constants'
import sx, {SxProp} from '../sx'
import Truncate from '../Truncate'
Expand All @@ -13,6 +13,7 @@ import {
activeDescendantActivatedIndirectly,
isActiveDescendantAttribute
} from '../behaviors/focusZone'
import {uniqueId} from '../utils/uniqueId'

/**
* These colors are not yet in our default theme. Need to remove this once they are added.
Expand Down Expand Up @@ -153,11 +154,21 @@ const getItemVariant = (variant = 'default', disabled?: boolean) => {
}
}

const StyledItemContent = styled.div`
const DividedContent = styled.div`
display: flex;
min-width: 0;
flex-grow: 1;

/* Required for dividers */
position: relative;
flex-grow: 1;
`

const MainContent = styled.div`
align-items: baseline;
display: flex;
min-width: 0;
flex-direction: var(--main-content-flex-direction);
flex-grow: 1;
`

const StyledItem = styled.div<
Expand Down Expand Up @@ -193,7 +204,7 @@ const StyledItem = styled.div<
:not(:first-of-type):not(${StyledDivider} + &):not(${StyledHeader} + &) {
margin-top: ${({showDivider}) => (showDivider ? `1px` : '0')};

${StyledItemContent}::before {
${DividedContent}::before {
content: ' ';
display: block;
position: absolute;
Expand All @@ -207,23 +218,23 @@ const StyledItem = styled.div<

// Item dividers should not be visible:
// - above Hovered
&:hover ${StyledItemContent}::before,
&:hover ${DividedContent}::before,
// - below Hovered
// '*' instead of '&' because '&' maps to separate class names depending on 'variant'
:hover + * ${StyledItemContent}::before {
:hover + * ${DividedContent}::before {
// allow override in case another item in the list is active/focused
border-color: var(--item-hover-divider-border-color-override, transparent) !important;
}

// - above Focused
&:focus ${StyledItemContent}::before,
&:focus ${DividedContent}::before,
// - below Focused
// '*' instead of '&' because '&' maps to separate class names depending on 'variant'
:focus + * ${StyledItemContent}::before,
:focus + * ${DividedContent}::before,
// - above Active Descendent
&[${isActiveDescendantAttribute}] ${StyledItemContent}::before,
&[${isActiveDescendantAttribute}] ${DividedContent}::before,
// - below Active Descendent
[${isActiveDescendantAttribute}] + & ${StyledItemContent}::before {
[${isActiveDescendantAttribute}] + & ${DividedContent}::before {
// '!important' because all the ':not's above give higher specificity
border-color: transparent !important;
}
Expand All @@ -248,27 +259,16 @@ const StyledItem = styled.div<
${sx}
`

export const TextContainer = styled.div<{
export const TextContainer = styled.span<{
dangerouslySetInnerHtml?: React.DOMAttributes<HTMLDivElement>['dangerouslySetInnerHTML']
descriptionVariant: ItemProps['descriptionVariant']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will require an adjustment on the memex side.

}>`
display: flex;
min-width: 0;
flex-grow: 1;
flex-direction: ${({descriptionVariant}) => (descriptionVariant === 'inline' ? 'row' : 'column')};
align-items: baseline;
`
}>``

const BaseVisualContainer = styled.div<{variant?: ItemProps['variant']; disabled?: boolean}>`
// Match visual height to adjacent text line height.
// TODO: When rem-based spacing on a 4px scale lands, replace
// hardcoded '20px' with '${get('space.s20')}'.
height: 20px;
width: ${get('space.3')};
flex-shrink: 0;
display: flex;
flex-direction: column;
justify-content: center;
margin-right: ${get('space.2')};
`

Expand All @@ -279,30 +279,33 @@ const ColoredVisualContainer = styled(BaseVisualContainer)`
}
`

const LeadingVisualContainer = styled(ColoredVisualContainer)``
const LeadingVisualContainer = styled(ColoredVisualContainer)`
flex-shrink: 0;
display: flex;
flex-direction: column;
justify-content: center;
`

const TrailingVisualContainer = styled(ColoredVisualContainer)`
const TrailingContent = styled(ColoredVisualContainer)`
color: ${({variant, disabled}) => getItemVariant(variant, disabled).annotationColor}};
margin-left: ${get('space.2')};
margin-right: 0;
width: auto;
div:nth-child(2) {
margin-left: ${get('space.2')};
}
display: flex;
flex-direction: row;
justify-content: flex-end;
`

const DescriptionContainer = styled.span<{descriptionVariant: ItemProps['descriptionVariant']}>`
const DescriptionContainer = styled.span`
color: ${get('colors.text.secondary')};
font-size: ${get('fontSizes.0')};
// TODO: When rem-based spacing on a 4px scale lands, replace
// hardcoded '16px' with '${get('lh-12')}'.
line-height: 16px;
margin-left: ${({descriptionVariant}) => (descriptionVariant === 'inline' ? get('space.2') : 0)};
margin-left: var(--description-container-margin-left);
min-width: 0;
flex-grow: 1;
flex-basis: ${({descriptionVariant}) => (descriptionVariant === 'inline' ? 0 : 'auto')};
flex-basis: var(--description-container-flex-basis);
`

const MultiSelectInput = styled.input`
Expand Down Expand Up @@ -333,6 +336,9 @@ export function Item(itemProps: Partial<ItemProps> & {item?: ItemInput}): JSX.El
...props
} = itemProps

const labelId = useMemo(() => uniqueId(), [])
const descriptionId = useMemo(() => uniqueId(), [])

const keyPressHandler = useCallback(
event => {
if (disabled) {
Expand Down Expand Up @@ -377,6 +383,8 @@ export function Item(itemProps: Partial<ItemProps> & {item?: ItemInput}): JSX.El
variant={variant}
showDivider={showDivider}
aria-selected={selected}
aria-labelledby={text ? labelId : undefined}
aria-describedby={description ? descriptionId : undefined}
{...props}
data-id={id}
onKeyPress={keyPressHandler}
Expand Down Expand Up @@ -412,35 +420,41 @@ export function Item(itemProps: Partial<ItemProps> & {item?: ItemInput}): JSX.El
<LeadingVisual />
</LeadingVisualContainer>
)}
<StyledItemContent>
{children}
{(text || description) && (
<TextContainer descriptionVariant={descriptionVariant}>
{text && <div>{text}</div>}
{description && (
<DescriptionContainer descriptionVariant={descriptionVariant}>
{descriptionVariant === 'block' ? (
description
) : (
<Truncate title={description} inline={true} maxWidth="100%">
{description}
</Truncate>
)}
</DescriptionContainer>
)}
</TextContainer>
)}
{(TrailingIcon || trailingText) && (
<TrailingVisualContainer variant={variant} disabled={disabled}>
{trailingText && <div>{trailingText}</div>}
{TrailingIcon && (
<div>
<TrailingIcon />
</div>
)}
</TrailingVisualContainer>
)}
</StyledItemContent>
<DividedContent>
<MainContent
style={
{'--main-content-flex-direction': descriptionVariant === 'inline' ? 'row' : 'column'} as React.CSSProperties
}
>
{children}
{text ? <TextContainer id={labelId}>{text}</TextContainer> : null}
{description ? (
<DescriptionContainer
id={descriptionId}
style={
{
'--description-container-margin-left': descriptionVariant === 'inline' ? get('space.2')(theme) : 0,
'--description-container-flex-basis': descriptionVariant === 'inline' ? 0 : 'auto'
} as React.CSSProperties
}
>
{descriptionVariant === 'block' ? (
description
) : (
<Truncate title={description} inline={true} maxWidth="100%">
{description}
</Truncate>
)}
</DescriptionContainer>
) : null}
</MainContent>
{TrailingIcon || trailingText ? (
<TrailingContent variant={variant} disabled={disabled}>
{trailingText}
{TrailingIcon && <TrailingIcon />}
</TrailingContent>
) : null}
</DividedContent>
</StyledItem>
)
}