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.

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

Add block areas tabbed sidebar to the widgets screen #22467

Merged
merged 2 commits into from
May 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { hasBlockSupport } from '@wordpress/blocks';
import { useSelect } from '@wordpress/data';

/**
* Internal dependencies
Expand All @@ -10,6 +12,24 @@ import NavigableToolbar from '../navigable-toolbar';
import { BlockToolbar } from '../';

function BlockContextualToolbar( { focusOnMount, ...props } ) {
const { blockType } = useSelect( ( select ) => {
const { getBlockName, getSelectedBlockClientIds } = select(
'core/block-editor'
);
const { getBlockType } = select( 'core/blocks' );
const selectedBlockClientIds = getSelectedBlockClientIds();
const selectedBlockClientId = selectedBlockClientIds[ 0 ];
return {
blockType:
selectedBlockClientId &&
getBlockType( getBlockName( selectedBlockClientId ) ),
};
} );
if ( blockType ) {
if ( ! hasBlockSupport( blockType, '__experimentalToolbar', true ) ) {
return null;
}
}
return (
<div className="block-editor-block-contextual-toolbar-wrapper">
<NavigableToolbar
Expand Down
14 changes: 14 additions & 0 deletions packages/block-editor/src/components/block-toolbar/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import classnames from 'classnames';
import { useSelect } from '@wordpress/data';
import { useRef } from '@wordpress/element';
import { useViewportMatch } from '@wordpress/compose';
import { hasBlockSupport } from '@wordpress/blocks';

/**
* Internal dependencies
*/
Expand All @@ -23,12 +25,15 @@ export default function BlockToolbar( { hideDragHandle } ) {
const {
blockClientIds,
blockClientId,
blockType,
hasFixedToolbar,
isValid,
mode,
moverDirection,
} = useSelect( ( select ) => {
const { getBlockType } = select( 'core/blocks' );
const {
getBlockName,
getBlockMode,
getSelectedBlockClientIds,
isBlockValid,
Expand All @@ -46,6 +51,9 @@ export default function BlockToolbar( { hideDragHandle } ) {
return {
blockClientIds: selectedBlockClientIds,
blockClientId: selectedBlockClientId,
blockType:
selectedBlockClientId &&
getBlockType( getBlockName( selectedBlockClientId ) ),
hasFixedToolbar: getSettings().hasFixedToolbar,
rootClientId: blockRootClientId,
isValid:
Expand Down Expand Up @@ -73,6 +81,12 @@ export default function BlockToolbar( { hideDragHandle } ) {
const displayHeaderToolbar =
useViewportMatch( 'medium', '<' ) || hasFixedToolbar;

if ( blockType ) {
if ( ! hasBlockSupport( blockType, '__experimentalToolbar', true ) ) {
return null;
}
}

const shouldShowMovers = displayHeaderToolbar || showMovers;

if ( blockClientIds.length === 0 ) {
Expand Down
3 changes: 2 additions & 1 deletion packages/block-library/src/widget-area/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"supports": {
"html": false,
"inserter": false,
"customClassName": false
"customClassName": false,
"__experimentalToolbar": false
}
}
1 change: 1 addition & 0 deletions packages/edit-widgets/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"@wordpress/keycodes": "file:../keycodes",
"@wordpress/media-utils": "file:../media-utils",
"@wordpress/notices": "file:../notices",
"classnames": "^2.2.5",
"lodash": "^4.17.15",
"rememo": "^3.0.0"
},
Expand Down
81 changes: 81 additions & 0 deletions packages/edit-widgets/src/components/sidebar/block-areas.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/**
* WordPress dependencies
*/
import { useDispatch, useSelect } from '@wordpress/data';
import { blockDefault } from '@wordpress/icons';
import { BlockIcon } from '@wordpress/block-editor';
import { Button } from '@wordpress/components';
import { __ } from '@wordpress/i18n';

function BlockArea( { clientId } ) {
const { name, selectedBlock } = useSelect(
( select ) => {
const { getBlockAttributes, getBlockSelectionStart } = select(
'core/block-editor'
);
return {
name: getBlockAttributes( clientId ).name,
selectedBlock: getBlockSelectionStart(),
};
},
[ clientId ]
);
const { selectBlock } = useDispatch( 'core/block-editor' );
const isSelected = selectedBlock === clientId;
return (
<li>
<Button
aria-expanded={ isSelected }
onClick={
isSelected
? undefined
: () => {
selectBlock( clientId );
}
}
>
{ name }
<span className="edit-widgets-block-areas__edit">
{ __( 'Edit' ) }
</span>
</Button>
</li>
);
}

export default function BlockAreas() {
const blockOrder = useSelect( ( select ) => {
return select( 'core/block-editor' ).getBlockOrder();
} );
const hasBlockAreas = blockOrder.length > 0;
return (
<>
<div className="edit-widgets-block-areas">
<div className="edit-widgets-block-areas__top-container">
<BlockIcon icon={ blockDefault } />
<div>
<p>
{ __(
'Block Areas (also known as "Widget Areas") are global parts in your site\'s layout that can accept blocks. These vary by theme, but are typically parts like your Sidebar or Footer.'
) }
</p>
{ ! hasBlockAreas && (
<p>
{ __(
'Your theme does not contain block areas.'
) }
</p>
) }
</div>
</div>
{ hasBlockAreas && (
<ul>
{ blockOrder.map( ( clientId ) => (
<BlockArea key={ clientId } clientId={ clientId } />
) ) }
</ul>
) }
</div>
</>
);
}
129 changes: 124 additions & 5 deletions packages/edit-widgets/src/components/sidebar/index.js
Original file line number Diff line number Diff line change
@@ -1,22 +1,141 @@
/**
* External dependencies
*/
import { map } from 'lodash';
import classnames from 'classnames';

/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { useEffect } from '@wordpress/element';
import { __, sprintf } from '@wordpress/i18n';
import { ComplementaryArea } from '@wordpress/interface';
import { BlockInspector } from '@wordpress/block-editor';
import { cog } from '@wordpress/icons';
import { Button } from '@wordpress/components';
import { useSelect, useDispatch } from '@wordpress/data';

/**
* Internal dependencies
*/
import BlockAreas from './block-areas';

const CORE_WIDGET_COMPLEMENTARY_AREAS = {
'edit-widgets/block-areas': __( 'Block areas' ),
'edit-widgets/block-inspector': __( 'Block' ),
};

function ComplementaryAreaHeader( { activeComplementaryArea } ) {
const { enableComplementaryArea } = useDispatch( 'core/interface' );
return (
<ul>
{ map( CORE_WIDGET_COMPLEMENTARY_AREAS, ( label, identifier ) => {
const isActive = identifier === activeComplementaryArea;
return (
<li key={ identifier }>
<Button
onClick={ () =>
enableComplementaryArea(
'core/edit-widgets',
identifier
)
}
className={ classnames(
'edit-widgets-sidebar__panel-tab',
{
'is-active': isActive,
}
) }
aria-label={
isActive
? // translators: %s: sidebar label e.g: "Block areas".
sprintf( __( '%s (selected)' ), label )
: label
}
data-label={ label }
>
{ label }
</Button>
</li>
);
} ) }
</ul>
);
}

export default function Sidebar() {
const { enableComplementaryArea } = useDispatch( 'core/interface' );
const {
currentArea,
hasSelectedNonAreaBlock,
isGeneralSidebarOpen,
} = useSelect( ( select ) => {
let activeArea = select( 'core/interface' ).getActiveComplementaryArea(
'core/edit-widgets'
);
const isSidebarOpen = !! activeArea;
const { getBlockSelectionStart, getBlockRootClientId } = select(
'core/block-editor'
);
const selectionStart = getBlockSelectionStart();
if ( ! CORE_WIDGET_COMPLEMENTARY_AREAS[ activeArea ] ) {
if ( ! selectionStart ) {
activeArea = 'edit-widgets/block-areas';
} else {
activeArea = 'edit-widgets/block-inspector';
}
}
return {
currentArea: activeArea,
hasSelectedNonAreaBlock: !! (
selectionStart && getBlockRootClientId( selectionStart )
),
isGeneralSidebarOpen: isSidebarOpen,
};
}, [] );

// currentArea, and isGeneralSidebarOpen are intentionally left out from the dependencies,
// because we want to run the effect when a block is selected/unselected and not when the sidebar state changes.
useEffect( () => {
if (
hasSelectedNonAreaBlock &&
currentArea === 'edit-widgets/block-areas' &&
isGeneralSidebarOpen
) {
enableComplementaryArea(
'core/edit-widgets',
'edit-widgets/block-inspector'
);
}
if (
! hasSelectedNonAreaBlock &&
currentArea === 'edit-widgets/block-inspector' &&
isGeneralSidebarOpen
) {
enableComplementaryArea(
'core/edit-widgets',
'edit-widgets/block-areas'
);
}
}, [ hasSelectedNonAreaBlock, enableComplementaryArea ] );

return (
<ComplementaryArea
className="edit-widgets-sidebar"
smallScreenTitle={ __( 'Widget Areas' ) }
header={
<ComplementaryAreaHeader
activeComplementaryArea={ currentArea }
/>
}
headerClassName="edit-widgets-sidebar__panel-tabs"
scope="core/edit-widgets"
complementaryAreaIdentifier="edit-widgets/block-inspector"
title={ __( 'Block' ) }
identifier={ currentArea }
icon={ cog }
>
<BlockInspector showNoBlockSelectedMessage={ false } />
{ currentArea === 'edit-widgets/block-areas' && <BlockAreas /> }
{ currentArea === 'edit-widgets/block-inspector' && (
<BlockInspector />
) }
</ComplementaryArea>
);
}
Loading