-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Process shortcodes before processing blocks so that dynamic blocks, b…
…y default, do not have shortcodes expanded
- Loading branch information
Showing
23 changed files
with
2,540 additions
and
2 deletions.
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
packages/block-editor/src/components/off-canvas-editor/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Off Canvas Editor | ||
|
||
The OffCanvasEditor component is a modified ListView compoent. It provides an overview of the hierarchical structure of all blocks in the editor. The blocks are presented vertically one below the other. It enables editing of hierarchy and addition of elements in the block tree without selecting the block instance on the canvas. | ||
|
||
It is an experimental component which may end up completely merged into the ListView component via configuration props. |
100 changes: 100 additions & 0 deletions
100
packages/block-editor/src/components/off-canvas-editor/appender.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { useInstanceId } from '@wordpress/compose'; | ||
import { speak } from '@wordpress/a11y'; | ||
import { useSelect } from '@wordpress/data'; | ||
import { forwardRef, useState, useEffect } from '@wordpress/element'; | ||
import { __, sprintf } from '@wordpress/i18n'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import { store as blockEditorStore } from '../../store'; | ||
import useBlockDisplayTitle from '../block-title/use-block-display-title'; | ||
import { ComposedPrivateInserter as PrivateInserter } from '../inserter'; | ||
|
||
export const Appender = forwardRef( | ||
( { nestingLevel, blockCount, clientId, ...props }, ref ) => { | ||
const [ insertedBlock, setInsertedBlock ] = useState( null ); | ||
|
||
const instanceId = useInstanceId( Appender ); | ||
const { hideInserter } = useSelect( | ||
( select ) => { | ||
const { getTemplateLock, __unstableGetEditorMode } = | ||
select( blockEditorStore ); | ||
|
||
return { | ||
hideInserter: | ||
!! getTemplateLock( clientId ) || | ||
__unstableGetEditorMode() === 'zoom-out', | ||
}; | ||
}, | ||
[ clientId ] | ||
); | ||
|
||
const blockTitle = useBlockDisplayTitle( { | ||
clientId, | ||
context: 'list-view', | ||
} ); | ||
|
||
const insertedBlockTitle = useBlockDisplayTitle( { | ||
clientId: insertedBlock?.clientId, | ||
context: 'list-view', | ||
} ); | ||
|
||
useEffect( () => { | ||
if ( ! insertedBlockTitle?.length ) { | ||
return; | ||
} | ||
|
||
speak( | ||
sprintf( | ||
// translators: %s: name of block being inserted (i.e. Paragraph, Image, Group etc) | ||
__( '%s block inserted' ), | ||
insertedBlockTitle | ||
), | ||
'assertive' | ||
); | ||
}, [ insertedBlockTitle ] ); | ||
|
||
if ( hideInserter ) { | ||
return null; | ||
} | ||
const descriptionId = `off-canvas-editor-appender__${ instanceId }`; | ||
const description = sprintf( | ||
/* translators: 1: The name of the block. 2: The numerical position of the block. 3: The level of nesting for the block. */ | ||
__( 'Append to %1$s block at position %2$d, Level %3$d' ), | ||
blockTitle, | ||
blockCount + 1, | ||
nestingLevel | ||
); | ||
|
||
return ( | ||
<div className="offcanvas-editor-appender"> | ||
<PrivateInserter | ||
ref={ ref } | ||
rootClientId={ clientId } | ||
position="bottom right" | ||
isAppender | ||
selectBlockOnInsert={ false } | ||
shouldDirectInsert={ false } | ||
__experimentalIsQuick | ||
{ ...props } | ||
toggleProps={ { 'aria-describedby': descriptionId } } | ||
onSelectOrClose={ ( maybeInsertedBlock ) => { | ||
if ( maybeInsertedBlock?.clientId ) { | ||
setInsertedBlock( maybeInsertedBlock ); | ||
} | ||
} } | ||
/> | ||
<div | ||
className="offcanvas-editor-appender__description" | ||
id={ descriptionId } | ||
> | ||
{ description } | ||
</div> | ||
</div> | ||
); | ||
} | ||
); |
156 changes: 156 additions & 0 deletions
156
packages/block-editor/src/components/off-canvas-editor/block-contents.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import classnames from 'classnames'; | ||
|
||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { useSelect } from '@wordpress/data'; | ||
import { forwardRef, useEffect, useState } from '@wordpress/element'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import { unlock } from '../../lock-unlock'; | ||
import ListViewBlockSelectButton from './block-select-button'; | ||
import BlockDraggable from '../block-draggable'; | ||
import { store as blockEditorStore } from '../../store'; | ||
import { updateAttributes } from './update-attributes'; | ||
import { LinkUI } from './link-ui'; | ||
import { useInsertedBlock } from './use-inserted-block'; | ||
import { useListViewContext } from './context'; | ||
|
||
const BLOCKS_WITH_LINK_UI_SUPPORT = [ | ||
'core/navigation-link', | ||
'core/navigation-submenu', | ||
]; | ||
|
||
const ListViewBlockContents = forwardRef( | ||
( | ||
{ | ||
onClick, | ||
onToggleExpanded, | ||
block, | ||
isSelected, | ||
position, | ||
siblingBlockCount, | ||
level, | ||
isExpanded, | ||
selectedClientIds, | ||
...props | ||
}, | ||
ref | ||
) => { | ||
const { clientId } = block; | ||
const [ isLinkUIOpen, setIsLinkUIOpen ] = useState(); | ||
const { | ||
blockMovingClientId, | ||
selectedBlockInBlockEditor, | ||
lastInsertedBlockClientId, | ||
} = useSelect( | ||
( select ) => { | ||
const { | ||
hasBlockMovingClientId, | ||
getSelectedBlockClientId, | ||
getLastInsertedBlocksClientIds, | ||
} = unlock( select( blockEditorStore ) ); | ||
const lastInsertedBlocksClientIds = | ||
getLastInsertedBlocksClientIds(); | ||
return { | ||
blockMovingClientId: hasBlockMovingClientId(), | ||
selectedBlockInBlockEditor: getSelectedBlockClientId(), | ||
lastInsertedBlockClientId: | ||
lastInsertedBlocksClientIds && | ||
lastInsertedBlocksClientIds[ 0 ], | ||
}; | ||
}, | ||
[ clientId ] | ||
); | ||
|
||
const { | ||
insertedBlockAttributes, | ||
insertedBlockName, | ||
setInsertedBlockAttributes, | ||
} = useInsertedBlock( lastInsertedBlockClientId ); | ||
|
||
const hasExistingLinkValue = insertedBlockAttributes?.url; | ||
|
||
useEffect( () => { | ||
if ( | ||
clientId === lastInsertedBlockClientId && | ||
BLOCKS_WITH_LINK_UI_SUPPORT?.includes( insertedBlockName ) && | ||
! hasExistingLinkValue // don't re-show the Link UI if the block already has a link value. | ||
) { | ||
setIsLinkUIOpen( true ); | ||
} | ||
}, [ | ||
lastInsertedBlockClientId, | ||
clientId, | ||
insertedBlockName, | ||
hasExistingLinkValue, | ||
] ); | ||
|
||
const { renderAdditionalBlockUI } = useListViewContext(); | ||
|
||
const isBlockMoveTarget = | ||
blockMovingClientId && selectedBlockInBlockEditor === clientId; | ||
|
||
const className = classnames( 'block-editor-list-view-block-contents', { | ||
'is-dropping-before': isBlockMoveTarget, | ||
} ); | ||
|
||
// Only include all selected blocks if the currently clicked on block | ||
// is one of the selected blocks. This ensures that if a user attempts | ||
// to drag a block that isn't part of the selection, they're still able | ||
// to drag it and rearrange its position. | ||
const draggableClientIds = selectedClientIds.includes( clientId ) | ||
? selectedClientIds | ||
: [ clientId ]; | ||
|
||
return ( | ||
<> | ||
{ renderAdditionalBlockUI && renderAdditionalBlockUI( block ) } | ||
{ isLinkUIOpen && ( | ||
<LinkUI | ||
clientId={ lastInsertedBlockClientId } | ||
link={ insertedBlockAttributes } | ||
onClose={ () => setIsLinkUIOpen( false ) } | ||
hasCreateSuggestion={ false } | ||
onChange={ ( updatedValue ) => { | ||
updateAttributes( | ||
updatedValue, | ||
setInsertedBlockAttributes, | ||
insertedBlockAttributes | ||
); | ||
setIsLinkUIOpen( false ); | ||
} } | ||
onCancel={ () => setIsLinkUIOpen( false ) } | ||
/> | ||
) } | ||
<BlockDraggable clientIds={ draggableClientIds }> | ||
{ ( { draggable, onDragStart, onDragEnd } ) => ( | ||
<ListViewBlockSelectButton | ||
ref={ ref } | ||
className={ className } | ||
block={ block } | ||
onClick={ onClick } | ||
onToggleExpanded={ onToggleExpanded } | ||
isSelected={ isSelected } | ||
position={ position } | ||
siblingBlockCount={ siblingBlockCount } | ||
level={ level } | ||
draggable={ draggable } | ||
onDragStart={ onDragStart } | ||
onDragEnd={ onDragEnd } | ||
isExpanded={ isExpanded } | ||
{ ...props } | ||
/> | ||
) } | ||
</BlockDraggable> | ||
</> | ||
); | ||
} | ||
); | ||
|
||
export default ListViewBlockContents; |
128 changes: 128 additions & 0 deletions
128
packages/block-editor/src/components/off-canvas-editor/block-select-button.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import classnames from 'classnames'; | ||
|
||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { | ||
Button, | ||
__experimentalHStack as HStack, | ||
__experimentalTruncate as Truncate, | ||
} from '@wordpress/components'; | ||
import { forwardRef } from '@wordpress/element'; | ||
import { Icon, lockSmall as lock } from '@wordpress/icons'; | ||
import { SPACE, ENTER } from '@wordpress/keycodes'; | ||
import { sprintf, __ } from '@wordpress/i18n'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import BlockIcon from '../block-icon'; | ||
import useBlockDisplayInformation from '../use-block-display-information'; | ||
import useBlockDisplayTitle from '../block-title/use-block-display-title'; | ||
import ListViewExpander from './expander'; | ||
import { useBlockLock } from '../block-lock'; | ||
|
||
function ListViewBlockSelectButton( | ||
{ | ||
className, | ||
block, | ||
onClick, | ||
onToggleExpanded, | ||
tabIndex, | ||
onFocus, | ||
onDragStart, | ||
onDragEnd, | ||
draggable, | ||
}, | ||
ref | ||
) { | ||
const { clientId } = block; | ||
const blockInformation = useBlockDisplayInformation( clientId ); | ||
const blockTitle = useBlockDisplayTitle( { | ||
clientId, | ||
context: 'list-view', | ||
} ); | ||
const { isLocked } = useBlockLock( clientId ); | ||
|
||
// The `href` attribute triggers the browser's native HTML drag operations. | ||
// When the link is dragged, the element's outerHTML is set in DataTransfer object as text/html. | ||
// We need to clear any HTML drag data to prevent `pasteHandler` from firing | ||
// inside the `useOnBlockDrop` hook. | ||
const onDragStartHandler = ( event ) => { | ||
event.dataTransfer.clearData(); | ||
onDragStart?.( event ); | ||
}; | ||
|
||
function onKeyDownHandler( event ) { | ||
if ( event.keyCode === ENTER || event.keyCode === SPACE ) { | ||
onClick( event ); | ||
} | ||
} | ||
|
||
const editAriaLabel = blockInformation | ||
? sprintf( | ||
// translators: %s: The title of the block. | ||
__( 'Edit %s block' ), | ||
blockInformation.title | ||
) | ||
: __( 'Edit' ); | ||
|
||
return ( | ||
<> | ||
<Button | ||
className={ classnames( | ||
'block-editor-list-view-block-select-button', | ||
className | ||
) } | ||
onClick={ onClick } | ||
onKeyDown={ onKeyDownHandler } | ||
ref={ ref } | ||
tabIndex={ tabIndex } | ||
onFocus={ onFocus } | ||
onDragStart={ onDragStartHandler } | ||
onDragEnd={ onDragEnd } | ||
draggable={ draggable } | ||
href={ `#block-${ clientId }` } | ||
aria-hidden={ true } | ||
title={ editAriaLabel } | ||
> | ||
<ListViewExpander onClick={ onToggleExpanded } /> | ||
<BlockIcon | ||
icon={ blockInformation?.icon } | ||
showColors | ||
context="list-view" | ||
/> | ||
<HStack | ||
alignment="center" | ||
className="block-editor-list-view-block-select-button__label-wrapper" | ||
justify="flex-start" | ||
spacing={ 1 } | ||
> | ||
<span className="block-editor-list-view-block-select-button__title"> | ||
<Truncate ellipsizeMode="auto">{ blockTitle }</Truncate> | ||
</span> | ||
{ blockInformation?.anchor && ( | ||
<span className="block-editor-list-view-block-select-button__anchor-wrapper"> | ||
<Truncate | ||
className="block-editor-list-view-block-select-button__anchor" | ||
ellipsizeMode="auto" | ||
> | ||
{ blockInformation.anchor } | ||
</Truncate> | ||
</span> | ||
) } | ||
{ isLocked && ( | ||
<span className="block-editor-list-view-block-select-button__lock"> | ||
<Icon icon={ lock } /> | ||
</span> | ||
) } | ||
</HStack> | ||
</Button> | ||
</> | ||
); | ||
} | ||
|
||
export default forwardRef( ListViewBlockSelectButton ); |
Oops, something went wrong.