Skip to content

Border Controls: Passthrough popover props instead of class names #40836

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

Closed
aaronrobertshaw wants to merge 10 commits into from
Closed

Border Controls: Passthrough popover props instead of class names #40836

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3504194
Move assignment of popover class name to popoverProps on Dropdown
aaronrobertshaw May 5, 2022
8d75e8e
Remove placeholder CSS class that was only there to satisfy TypeScript
aaronrobertshaw May 5, 2022
49d1f65
Switch border control dropdown to popoverProps
aaronrobertshaw May 5, 2022
a183d9d
Switch border control component to popoverProps
aaronrobertshaw May 5, 2022
cfdf0e8
Switch BorderBoxControl to popoversProps
aaronrobertshaw May 5, 2022
9c75458
Switch border support to use popoversProps
aaronrobertshaw May 5, 2022
0e67fce
Update border control readmes for new popoverProps prop
aaronrobertshaw May 5, 2022
d91b0ee
Add changelog
aaronrobertshaw May 5, 2022
8bd8737
Make ColorPalette className option by adding default as undefined
aaronrobertshaw May 5, 2022
cdf0cf1
Fix className typing error by moving prop destructuring
aaronrobertshaw May 6, 2022
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
Prev Previous commit
Next Next commit
Switch BorderBoxControl to popoversProps
  • Loading branch information
@aaronrobertshaw
aaronrobertshaw committed May 5, 2022
commit cfdf0e80ffff63fa0400eb01005d46cafdab2180
10 changes: 5 additions & 5 deletions packages/components/src/border-box-control/border-box-control-split-controls/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const BorderBoxControlSplitControls = (
enableAlpha,
enableStyle,
onChange,
popoverClassNames,
popoversProps,
value,
__experimentalHasMultipleOrigins,
__experimentalIsRenderedInSidebar,
Expand All @@ -50,23 +50,23 @@ const BorderBoxControlSplitControls = (
hideLabelFromVision={ true }
label={ __( 'Top border' ) }
onChange={ ( newBorder ) => onChange( newBorder, 'top' ) }
popoverProps={ { className: popoverClassNames?.top } }
popoverProps={ popoversProps?.top }
value={ value?.top }
{ ...sharedBorderControlProps }
/>
<BorderControl
hideLabelFromVision={ true }
label={ __( 'Left border' ) }
onChange={ ( newBorder ) => onChange( newBorder, 'left' ) }
popoverProps={ { className: popoverClassNames?.left } }
popoverProps={ popoversProps?.left }
value={ value?.left }
{ ...sharedBorderControlProps }
/>
<BorderControl
hideLabelFromVision={ true }
label={ __( 'Right border' ) }
onChange={ ( newBorder ) => onChange( newBorder, 'right' ) }
popoverProps={ { className: popoverClassNames?.right } }
popoverProps={ popoversProps?.right }
value={ value?.right }
{ ...sharedBorderControlProps }
/>
Expand All @@ -75,7 +75,7 @@ const BorderBoxControlSplitControls = (
hideLabelFromVision={ true }
label={ __( 'Bottom border' ) }
onChange={ ( newBorder ) => onChange( newBorder, 'bottom' ) }
popoverProps={ { className: popoverClassNames?.bottom } }
popoverProps={ popoversProps?.bottom }
value={ value?.bottom }
{ ...sharedBorderControlProps }
/>
Expand Down
8 changes: 3 additions & 5 deletions packages/components/src/border-box-control/border-box-control/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const BorderBoxControl = (
linkedValue,
onLinkedChange,
onSplitChange,
popoverClassNames,
popoversProps,
splitValue,
toggleLinked,
__experimentalHasMultipleOrigins,
Expand All @@ -77,9 +77,7 @@ const BorderBoxControl = (
placeholder={
hasMixedBorders ? __( 'Mixed' ) : undefined
}
popoverProps={ {
className: popoverClassNames?.linked,
} }
popoverProps={ popoversProps?.linked }
shouldSanitizeBorder={ false } // This component will handle that.
value={ linkedValue }
withSlider={ true }
Expand All @@ -98,7 +96,7 @@ const BorderBoxControl = (
enableAlpha={ enableAlpha }
enableStyle={ enableStyle }
onChange={ onSplitChange }
popoverClassNames={ popoverClassNames }
popoversProps={ popoversProps }
value={ splitValue }
__experimentalHasMultipleOrigins={
__experimentalHasMultipleOrigins
Expand Down
34 changes: 21 additions & 13 deletions packages/components/src/border-box-control/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
/**
* Internal dependencies
*/
import type { Border, ColorProps, LabelProps } from '../border-control/types';
import type {
Border,
ColorProps,
DropdownPopoverProps,
LabelProps,
} from '../border-control/types';

export type Borders = {
top?: Border;
Expand All @@ -14,12 +19,15 @@ export type AnyBorder = Border | Borders | undefined;
export type BorderProp = keyof Border;
export type BorderSide = keyof Borders;

export type PopoverClassNames = {
linked?: string;
top?: string;
right?: string;
bottom?: string;
left?: string;
/**
* Collection of `popoverProps` for each of the inner border controls.
*/
export type PopoversProps = {
linked?: DropdownPopoverProps;
top?: DropdownPopoverProps;
right?: DropdownPopoverProps;
bottom?: DropdownPopoverProps;
left?: DropdownPopoverProps;
};

export type BorderBoxControlProps = ColorProps &
Expand All @@ -35,10 +43,10 @@ export type BorderBoxControlProps = ColorProps &
*/
onChange: ( value: AnyBorder ) => void;
/**
* An object defining CSS classnames for all the inner `BorderControl`
* popover content.
* An object defining the `popoverProps` for all the inner
* `BorderControl` dropdowns.
*/
popoverClassNames?: PopoverClassNames;
popoversProps?: PopoversProps;
/**
* An object representing the current border configuration.
*
Expand Down Expand Up @@ -85,10 +93,10 @@ export type SplitControlsProps = ColorProps & {
*/
onChange: ( value: Border | undefined, side: BorderSide ) => void;
/**
* An object defining CSS classnames for the split side `BorderControl`s'
* popover content.
* An object defining the `popoverProps` for the split side
* `BorderControl` dropdowns.
*/
popoverClassNames?: PopoverClassNames;
popoversProps?: PopoversProps;
/**
* An object representing the current border configuration. It contains
* properties for each side, with each side an object reflecting the border
Expand Down
2 changes: 1 addition & 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 @@ -26,7 +26,7 @@ export type Colors = ColorOrigin[] | Color[];
* dropdown's `popoverProps`. This should be replaced once the Dropdown or
* Popover components are typed.
*/
type DropdownPopoverProps = {
export type DropdownPopoverProps = {
className?: string;
focusOnMount?: boolean;
position?: string;
Expand Down