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

BorderControl: Replace style picker with ToggleGroupControl #57562

Merged
merged 5 commits into from
Jan 24, 2024
Merged

BorderControl: Replace style picker with ToggleGroupControl #57562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
426cdf2
BorderControl: Replace style picker with ToggleGroupControl
mirka Jan 4, 2024
b9f167a
Add changelog
mirka Jan 10, 2024
4cdb215
Merge branch 'trunk' into border-control-toggle
mirka Jan 15, 2024
85389d8
Merge branch 'trunk' into border-control-toggle
mirka Jan 24, 2024
a63d7ee
Fix changelog placement
mirka Jan 24, 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 @@ -10,6 +10,7 @@
- `PaletteEdit` and `CircularOptionPicker`: improve unit tests ([#57809](https://github.com/WordPress/gutenberg/pull/57809)).
- `Tooltip`: no-op when nested inside other `Tooltip` components ([#57202](https://github.com/WordPress/gutenberg/pull/57202)).
- `Tooltip` and `Button`: tidy up unit tests ([#57975](https://github.com/WordPress/gutenberg/pull/57975)).
- `BorderControl`, `BorderBoxControl`: Replace style picker with ToggleGroupControl ([#57562](https://github.com/WordPress/gutenberg/pull/57562)).
- `SlotFill`: fix typo in use-slot-fills return docs ([#57654](https://github.com/WordPress/gutenberg/pull/57654))

### Bug Fix
Expand Down
3 changes: 2 additions & 1 deletion packages/components/src/border-control/border-control-dropdown/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ const BorderControlDropdown = (
enableStyle,
indicatorClassName,
indicatorWrapperClassName,
isStyleSettable,
onReset,
onColorChange,
onStyleChange,
Expand Down Expand Up @@ -218,7 +219,7 @@ const BorderControlDropdown = (
clearable={ false }
enableAlpha={ enableAlpha }
/>
{ enableStyle && (
{ enableStyle && isStyleSettable && (
<BorderControlStylePicker
label={ __( 'Style' ) }
value={ style }
Expand Down
97 changes: 31 additions & 66 deletions packages/components/src/border-control/border-control-style-picker/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,84 +7,49 @@ import { __ } from '@wordpress/i18n';
/**
* Internal dependencies
*/
import Button from '../../button';
import { StyledLabel } from '../../base-control/styles/base-control-styles';
import { View } from '../../view';
import { Flex } from '../../flex';
import { VisuallyHidden } from '../../visually-hidden';
import type { WordPressComponentProps } from '../../context';
import { contextConnect } from '../../context';
import { useBorderControlStylePicker } from './hook';

import type { LabelProps, StylePickerProps } from '../types';
import type { StylePickerProps } from '../types';
import {
ToggleGroupControl,
ToggleGroupControlOptionIcon,
} from '../../toggle-group-control';

const BORDER_STYLES = [
{ label: __( 'Solid' ), icon: lineSolid, value: 'solid' },
{ label: __( 'Dashed' ), icon: lineDashed, value: 'dashed' },
{ label: __( 'Dotted' ), icon: lineDotted, value: 'dotted' },
];

const Label = ( props: LabelProps ) => {
const { label, hideLabelFromVision } = props;

if ( ! label ) {
return null;
}

return hideLabelFromVision ? (
<VisuallyHidden as="label">{ label }</VisuallyHidden>
) : (
<StyledLabel>{ label }</StyledLabel>
);
};

const BorderControlStylePicker = (
props: WordPressComponentProps< StylePickerProps, 'div' >,
function UnconnectedBorderControlStylePicker(
{ onChange, ...restProps }: StylePickerProps,
forwardedRef: React.ForwardedRef< any >
) => {
const {
buttonClassName,
hideLabelFromVision,
label,
onChange,
value,
...otherProps
} = useBorderControlStylePicker( props );

) {
return (
<View { ...otherProps } ref={ forwardedRef }>
<Label
label={ label }
hideLabelFromVision={ hideLabelFromVision }
/>
<Flex justify="flex-start" gap={ 1 }>
{ BORDER_STYLES.map( ( borderStyle ) => (
<Button
key={ borderStyle.value }
className={ buttonClassName }
icon={ borderStyle.icon }
size="small"
isPressed={ borderStyle.value === value }
onClick={ () =>
onChange(
borderStyle.value === value
? undefined
: borderStyle.value
)
}
aria-label={ borderStyle.label }
label={ borderStyle.label }
showTooltip={ true }
/>
) ) }
</Flex>
</View>
<ToggleGroupControl
__nextHasNoMarginBottom
__next40pxDefaultSize
ref={ forwardedRef }
isDeselectable
onChange={ ( value ) => {
onChange?.( value as string | undefined );
} }
{ ...restProps }
>
{ BORDER_STYLES.map( ( borderStyle ) => (
<ToggleGroupControlOptionIcon
key={ borderStyle.value }
value={ borderStyle.value }
icon={ borderStyle.icon }
label={ borderStyle.label }
/>
) ) }
</ToggleGroupControl>
);
};
}

const ConnectedBorderControlStylePicker = contextConnect(
BorderControlStylePicker,
const BorderControlStylePicker = contextConnect(
UnconnectedBorderControlStylePicker,
'BorderControlStylePicker'
);

export default ConnectedBorderControlStylePicker;
export default BorderControlStylePicker;
35 changes: 0 additions & 35 deletions packages/components/src/border-control/border-control-style-picker/hook.ts
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions packages/components/src/border-control/border-control/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ const UnconnectedBorderControl = (
hideLabelFromVision,
innerWrapperClassName,
inputWidth,
isStyleSettable,
label,
onBorderChange,
onSliderChange,
Expand Down Expand Up @@ -81,6 +82,7 @@ const UnconnectedBorderControl = (
disableCustomColors={ disableCustomColors }
enableAlpha={ enableAlpha }
enableStyle={ enableStyle }
isStyleSettable={ isStyleSettable }
onChange={ onBorderChange }
previousStyleSelection={ previousStyleSelection }
showDropdownHeader={ showDropdownHeader }
Expand Down
27 changes: 14 additions & 13 deletions packages/components/src/border-control/border-control/hook.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,12 @@ import { useCx } from '../../utils/hooks/use-cx';

import type { Border, BorderControlProps } from '../types';

const sanitizeBorder = ( border?: Border ) => {
Copy link
Member Author

Choose a reason for hiding this comment

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

I refactored the logic of this sanitizeBorder function so it can be reused to determine the isStyleSettable boolean. I renamed it and inverted the logic to isValidBorder for better readability within the file.

const hasNoWidth = border?.width === undefined || border.width === '';
const hasNoColor = border?.color === undefined;

// If width and color are undefined, unset any style selection as well.
if ( hasNoWidth && hasNoColor ) {
return undefined;
}

return border;
// If either width or color are defined, the border is considered valid
// and a border style can be set as well.
const isValidBorder = ( border?: Border ) => {
const hasWidth = border?.width !== undefined && border.width !== '';
const hasColor = border?.color !== undefined;
return hasWidth || hasColor;
};

export function useBorderControl(
Expand Down Expand Up @@ -57,12 +53,16 @@ export function useBorderControl(
const [ colorSelection, setColorSelection ] = useState< string >();
const [ styleSelection, setStyleSelection ] = useState< string >();

const isStyleSettable = shouldSanitizeBorder
? isValidBorder( border )
: true;

const onBorderChange = useCallback(
( newBorder?: Border ) => {
if ( shouldSanitizeBorder ) {
return onChange( sanitizeBorder( newBorder ) );
if ( shouldSanitizeBorder && ! isValidBorder( newBorder ) ) {
onChange( undefined );
return;
}

onChange( newBorder );
},
[ onChange, shouldSanitizeBorder ]
Expand Down Expand Up @@ -151,6 +151,7 @@ export function useBorderControl(
enableStyle,
innerWrapperClassName,
inputWidth: wrapperWidth,
isStyleSettable,
onBorderChange,
onSliderChange,
onWidthChange,
Expand Down
15 changes: 0 additions & 15 deletions packages/components/src/border-control/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,21 +165,6 @@ export const resetButton = css`
}
`;

export const borderControlStylePicker = css`
${ StyledLabel } {
${ labelStyles }
}
`;

export const borderStyleButton = css`
&&&&& {
min-width: 32px;
width: 32px;
height: 32px;
padding: 4px;
}
`;

export const borderSlider = () => css`
flex: 1 1 60%;
${ rtl( { marginRight: space( 3 ) } )() }
Expand Down
10 changes: 9 additions & 1 deletion packages/components/src/border-control/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import type { CSSProperties } from 'react';
*/
import type { ColorPaletteProps } from '../color-palette/types';
import type { PopoverProps } from '../popover/types';
import type { ToggleGroupControlProps } from '../toggle-group-control/types';

export type Border = {
color?: CSSProperties[ 'borderColor' ];
Expand Down Expand Up @@ -115,6 +116,10 @@ export type DropdownProps = ColorProps &
* values for its popover controls.
*/
border?: Border;
/**
* Whether a border style can be set, based on the border sanitization settings.
*/
isStyleSettable: boolean;
Comment on lines +119 to +122
Copy link
Member Author

Choose a reason for hiding this comment

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

Just an addition to an internal subcomponent prop — will not affect public-facing types.

/**
* An internal prop used to control the visibility of the dropdown.
*/
Expand All @@ -137,7 +142,10 @@ export type DropdownProps = ColorProps &
showDropdownHeader?: boolean;
};

export type StylePickerProps = LabelProps & {
export type StylePickerProps = Omit<
ToggleGroupControlProps,
'value' | 'onChange' | 'children'
> & {
/**
* A callback function invoked when a border style is selected or cleared.
*/
Expand Down
Loading