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

CustomSelectControlV2: Handle long strings in selected value #62198

Merged
merged 4 commits into from
Jun 25, 2024
Merged

CustomSelectControlV2: Handle long strings in selected value #62198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
65e3a00
CustomSelectControlV2: Handle long strings in selected value
mirka May 31, 2024
a68fce4
Add truncate styles to custom render with hint
mirka May 31, 2024
4747d78
Add changelog
mirka May 31, 2024
b6604c4
Merge branch 'trunk' into custom-select-v2-long-strings
mirka Jun 25, 2024
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
1 change: 1 addition & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- `CustomSelectControl`: align unit tests for v1 and legacy v2 versions. ([#62706](https://github.com/WordPress/gutenberg/pull/62706))
- `CustomSelectControlV2`: fix handling of extra option attributes in the `onChange` callbacks and when forwarding them to the option DOM elements. ([#62255](https://github.com/WordPress/gutenberg/pull/62255))
- `CustomSelectControlV2`: fix setting initial value and reacting to external controlled updates. ([#62733](https://github.com/WordPress/gutenberg/pull/62733))
- `CustomSelectControlV2`: Handle long strings in selected value ([#62198](https://github.com/WordPress/gutenberg/pull/62198)).

## 28.1.0 (2024-06-15)

Expand Down
2 changes: 1 addition & 1 deletion packages/components/src/custom-select-control-v2/custom-select.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ const CustomSelectButton = ( {
// move selection rather than open the popover
showOnKeyDown={ false }
>
<div>{ computedRenderSelectedValue( currentValue ) }</div>
Copy link
Member Author

Choose a reason for hiding this comment

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

div is unnecessary.

{ computedRenderSelectedValue( currentValue ) }
</Styled.Select>
);
};
Expand Down
4 changes: 2 additions & 2 deletions packages/components/src/custom-select-control-v2/legacy-component/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,12 @@ function CustomSelectControl( props: LegacyCustomSelectProps ) {
);

return (
<>
<Styled.SelectedExperimentalHintWrapper>
Copy link
Member Author

Choose a reason for hiding this comment

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

Added a wrapper div to apply text truncation styles as in v1.

{ currentValue }
<Styled.SelectedExperimentalHintItem className="components-custom-select-control__hint">
{ currentHint?.__experimentalHint }
</Styled.SelectedExperimentalHintItem>
</>
</Styled.SelectedExperimentalHintWrapper>
);
};

Expand Down
32 changes: 22 additions & 10 deletions packages/components/src/custom-select-control-v2/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,27 @@ import styled from '@emotion/styled';
*/
import { COLORS, CONFIG } from '../utils';
import { space } from '../utils/space';
import { chevronIconSize } from '../select-control/styles/select-control-styles';
import type { CustomSelectButtonSize } from './types';

const ITEM_PADDING = space( 2 );

const truncateStyles = css`
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
`;

export const WithHintWrapper = styled.div`
display: flex;
justify-content: space-between;
flex: 1;
`;

export const SelectedExperimentalHintWrapper = styled.div`
${ truncateStyles }
`;

export const SelectedExperimentalHintItem = styled.span`
color: ${ COLORS.theme.gray[ 600 ] };
margin-inline-start: ${ space( 2 ) };
Expand Down Expand Up @@ -55,40 +66,41 @@ export const Select = styled( Ariakit.Select, {
const sizes = {
compact: {
[ heightProperty ]: 32,
paddingInlineStart: space( 2 ),
paddingInlineEnd: space( 1 ),
paddingInlineStart: 8,
Copy link
Member

Choose a reason for hiding this comment

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

Is there a good reason to stop using the grid space util and hardcode the padding widths like that?

Copy link
Member

Choose a reason for hiding this comment

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

Curious about that, too.

Copy link
Member Author

Choose a reason for hiding this comment

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

No big reason other than that I thought it was simpler to read in context, especially when I want to add the chevronIconSize like this. (space() returns a calc()).

paddingInlineEnd: 8 + chevronIconSize,
},
default: {
[ heightProperty ]: 40,
paddingInlineStart: space( 4 ),
paddingInlineEnd: space( 3 ),
paddingInlineStart: 16,
paddingInlineEnd: 16 + chevronIconSize,
},
small: {
[ heightProperty ]: 24,
paddingInlineStart: space( 2 ),
paddingInlineEnd: space( 1 ),
fontSize: 11,
paddingInlineStart: 8,
paddingInlineEnd: 8 + chevronIconSize,
},
};

return sizes[ size ] || sizes.default;
};

return css`
display: flex;
align-items: center;
justify-content: space-between;
Comment on lines -78 to -80
Copy link
Member Author

Choose a reason for hiding this comment

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

No reason for this to be a flexbox.

Copy link
Contributor

@ciampo ciampo Jun 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Knowing past Marco, there's a chance flexbox was used to automatically trim extra white space (although it's also very possible that this is a remnant of a previous style and it's totally fine to remove it)

Copy link
Contributor

Choose a reason for hiding this comment

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

Probably totally fine to remove it :D

display: block;
background-color: ${ COLORS.theme.background };
border: none;
color: ${ COLORS.theme.foreground };
cursor: pointer;
font-family: inherit;
Comment on lines +91 to +93
Copy link
Member Author

Choose a reason for hiding this comment

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

Correct color and font-family was missing.

font-size: ${ CONFIG.fontSize };
text-align: left;
Copy link
Member Author

Choose a reason for hiding this comment

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

Text align was missing.

Copy link
Member

Choose a reason for hiding this comment

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

Nice catch 👍 I wonder how this didn't come up earlier.

width: 100%;

&[data-focus-visible] {
outline: none; // handled by InputBase component
}

${ getSize() }
${ ! hasCustomRenderProp && truncateStyles }
Copy link
Member Author

Choose a reason for hiding this comment

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

We shouldn't add truncate styles when the consumer passes a custom render function.

`;
} );

Expand Down
Loading