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

Block Support: Set border style none when border width zero #32080

Merged
merged 2 commits into from
Jul 13, 2021
Merged

Block Support: Set border style none when border width zero #32080

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70fc06b
Set border style to none when 0 width
aaronrobertshaw May 21, 2021
955250b
Clear border color selection on 0 border width
aaronrobertshaw May 24, 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
61 changes: 58 additions & 3 deletions packages/block-editor/src/hooks/border-width.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
__experimentalUnitControl as UnitControl,
__experimentalUseCustomUnits as useCustomUnits,
} from '@wordpress/components';
import { useEffect, useState } from '@wordpress/element';
import { __ } from '@wordpress/i18n';

/**
Expand All @@ -24,10 +25,32 @@ const MIN_BORDER_WIDTH = 0;
*/
export const BorderWidthEdit = ( props ) => {
const {
attributes: { style },
attributes: { borderColor, style },
setAttributes,
} = props;

const { width, color: customBorderColor, style: borderStyle } =
style?.border || {};
const [ styleSelection, setStyleSelection ] = useState();
const [ colorSelection, setColorSelection ] = useState();

// Temporarily track previous border color & style selections to be able to
// restore them when border width changes from zero value.
useEffect( () => {
if ( borderStyle !== 'none' ) {
setStyleSelection( borderStyle );
}
}, [ borderStyle ] );

useEffect( () => {
if ( borderColor || customBorderColor ) {
setColorSelection( {
name: !! borderColor ? borderColor : undefined,
color: !! customBorderColor ? customBorderColor : undefined,
} );
}
}, [ borderColor, customBorderColor ] );

const onChange = ( newWidth ) => {
let newStyle = {
...style,
Expand All @@ -37,11 +60,43 @@ export const BorderWidthEdit = ( props ) => {
},
};

// Used to clear named border color attribute.
let borderPaletteColor = borderColor;

const hasZeroWidth = parseFloat( newWidth ) === 0;

// Setting the border width explicitly to zero will also set the
// border style to `none` and clear border color attributes.
if ( hasZeroWidth ) {
borderPaletteColor = undefined;
newStyle.border.color = undefined;
newStyle.border.style = 'none';
aaronrobertshaw marked this conversation as resolved.
Show resolved Hide resolved
}

// Restore previous border style selection if width is now not zero and
// border style was 'none'. This is to support changes to the UI which
// change the border style UI to a segmented control without a "none"
// option.
if ( ! hasZeroWidth && borderStyle === 'none' ) {
newStyle.border.style = styleSelection;
}

// Restore previous border color selection if width is no longer zero
// and current border color is undefined.
if ( ! hasZeroWidth && borderColor === undefined ) {
borderPaletteColor = colorSelection?.name;
newStyle.border.color = colorSelection?.color;
}

// If width was reset, clean out undefined styles.
if ( newWidth === undefined || newWidth === '' ) {
newStyle = cleanEmptyObject( newStyle );
}

setAttributes( { style: newStyle } );
setAttributes( {
borderColor: borderPaletteColor,
style: newStyle,
} );
};

const units = useCustomUnits( {
Expand All @@ -50,7 +105,7 @@ export const BorderWidthEdit = ( props ) => {

return (
<UnitControl
value={ style?.border?.width }
value={ width }
label={ __( 'Width' ) }
min={ MIN_BORDER_WIDTH }
onChange={ onChange }
Expand Down