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

Shadows: Improve accessibility of shadows dropdown #58828

Merged
merged 2 commits into from
Feb 23, 2024
Merged

Shadows: Improve accessibility of shadows dropdown #58828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f35fea
Improve accebility of shadows dropdown
madhusudhand Feb 8, 2024
585e821
fix mobile unit tests by moving privateApis unlock inside components
madhusudhand Feb 22, 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
54 changes: 40 additions & 14 deletions packages/block-editor/src/components/global-styles/shadow-panel-components.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,25 @@ import { __ } from '@wordpress/i18n';
import {
__experimentalVStack as VStack,
__experimentalHeading as Heading,
__experimentalGrid as Grid,
__experimentalHStack as HStack,
__experimentalDropdownContentWrapper as DropdownContentWrapper,
Button,
FlexItem,
Dropdown,
privateApis as componentsPrivateApis,
} from '@wordpress/components';
import { shadow as shadowIcon, Icon, check } from '@wordpress/icons';

/**
* External dependencies
*/
import classNames from 'classnames';

/**
* Internal dependencies
*/
import { unlock } from '../../lock-unlock';

export function ShadowPopoverContainer( { shadow, onShadowChange, settings } ) {
const defaultShadows = settings?.shadow?.presets?.default || [];
const themeShadows = settings?.shadow?.presets?.theme || [];
Expand All @@ -43,8 +49,16 @@ export function ShadowPopoverContainer( { shadow, onShadowChange, settings } ) {
}

export function ShadowPresets( { presets, activeShadow, onSelect } ) {
const { CompositeV2: Composite, useCompositeStoreV2: useCompositeStore } =
unlock( componentsPrivateApis );
const compositeStore = useCompositeStore();
return ! presets ? null : (
<Grid columns={ 6 } gap={ 0 } align="center" justify="center">
<Composite
store={ compositeStore }
role="listbox"
Comment on lines +52 to +58
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm surprised we need to unlock a component for this. Is there another way to build this custom listbox without needing to unlock the componentsPrivateApis for it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @jeryj. I followed the implementation of duotone as they both have similar UI. I will create a followup issue and address it as enhancement.

className="block-editor-global-styles__shadow__list"
aria-label={ __( 'Drop shadows' ) }
>
{ presets.map( ( { name, slug, shadow } ) => (
<ShadowIndicator
key={ slug }
Expand All @@ -56,23 +70,35 @@ export function ShadowPresets( { presets, activeShadow, onSelect } ) {
shadow={ shadow }
/>
) ) }
</Grid>
</Composite>
);
}

export function ShadowIndicator( { label, isActive, onSelect, shadow } ) {
const { CompositeItemV2: CompositeItem } = unlock( componentsPrivateApis );
return (
<div className="block-editor-global-styles__shadow-indicator-wrapper">
<Button
className="block-editor-global-styles__shadow-indicator"
onClick={ onSelect }
label={ label }
style={ { boxShadow: shadow } }
showTooltip
>
{ isActive && <Icon icon={ check } /> }
</Button>
</div>
<CompositeItem
role="option"
aria-label={ label }
aria-selected={ isActive }
className={ classNames(
'block-editor-global-styles__shadow__item',
{
'is-active': isActive,
}
) }
render={
<Button
Copy link
Contributor

Choose a reason for hiding this comment

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

Do these still need to be buttons? Having a button within an Option seems odd. Can we remove the button and have the shadow icon be the direct content of the <option> instead?

className="block-editor-global-styles__shadow-indicator"
onClick={ onSelect }
label={ label }
style={ { boxShadow: shadow } }
showTooltip
>
{ isActive && <Icon icon={ check } /> }
</Button>
}
/>
);
}

Expand Down
27 changes: 17 additions & 10 deletions packages/block-editor/src/components/global-styles/style.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,31 @@
}
}

// wrapper to clip the shadow beyond 6px
.block-editor-global-styles__shadow-indicator-wrapper {
padding: $grid-unit-15 * 0.5;
display: flex;
align-items: center;
justify-content: center;
}

// These styles are similar to the color palette.
.block-editor-global-styles__shadow-indicator {
color: $gray-800;
border: $gray-200 $border-width solid;
border-radius: $radius-block-ui;
cursor: pointer;
padding: 0;
margin-right: $grid-unit-15;
margin-bottom: $grid-unit-15;

height: $button-size-small + 2 * $border-width;
width: $button-size-small + 2 * $border-width;
box-sizing: border-box;

transform: scale(1);
transition: transform 0.1s ease;
will-change: transform;

height: $button-size-small;
width: $button-size-small;
&:focus {
border: #{ $border-width * 2 } solid $gray-700;
}

&:hover {
transform: scale(1.2);
}
}

.block-editor-global-styles-advanced-panel__custom-css-input textarea {
Expand Down
Loading