-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
List View: Add media previews to list view for gallery and image bloc…
…ks (#53381) * List View: Add images * Add some styling and a max number of images * Tweak styling * Add image count * Reduce to 3 images, remove image count
- Loading branch information
1 parent
5f92554
commit e522dd9
Showing
3 changed files
with
123 additions
and
0 deletions.
There are no files selected for viewing
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
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
79 changes: 79 additions & 0 deletions
79
packages/block-editor/src/components/list-view/use-list-view-images.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,79 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { useMemo } from '@wordpress/element'; | ||
import { useSelect } from '@wordpress/data'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import { store as blockEditorStore } from '../../store'; | ||
|
||
// Maximum number of images to display in a list view row. | ||
const MAX_IMAGES = 3; | ||
|
||
function getImageUrl( block ) { | ||
if ( block.name !== 'core/image' ) { | ||
return; | ||
} | ||
|
||
if ( block.attributes?.url ) { | ||
return { url: block.attributes.url, alt: block.attributes.alt }; | ||
} | ||
} | ||
|
||
function getImagesFromGallery( block ) { | ||
if ( block.name !== 'core/gallery' || ! block.innerBlocks ) { | ||
return []; | ||
} | ||
|
||
const images = []; | ||
|
||
for ( const innerBlock of block.innerBlocks ) { | ||
const img = getImageUrl( innerBlock ); | ||
if ( img ) { | ||
images.push( img ); | ||
} | ||
if ( images.length >= MAX_IMAGES ) { | ||
return images; | ||
} | ||
} | ||
|
||
return images; | ||
} | ||
|
||
function getImagesFromBlock( block, isExpanded ) { | ||
const img = getImageUrl( block ); | ||
if ( img ) { | ||
return [ img ]; | ||
} | ||
return isExpanded ? [] : getImagesFromGallery( block ); | ||
} | ||
|
||
/** | ||
* Get a block's preview images for display within a list view row. | ||
* | ||
* TODO: Currently only supports images from the core/image and core/gallery | ||
* blocks. This should be expanded to support other blocks that have images, | ||
* potentially via an API that blocks can opt into / provide their own logic. | ||
* | ||
* @param {Object} props Hook properties. | ||
* @param {string} props.clientId The block's clientId. | ||
* @param {boolean} props.isExpanded Whether or not the block is expanded in the list view. | ||
* @return {Array} Images. | ||
*/ | ||
export default function useListViewImages( { clientId, isExpanded } ) { | ||
const { block } = useSelect( | ||
( select ) => { | ||
const _block = select( blockEditorStore ).getBlock( clientId ); | ||
return { block: _block }; | ||
}, | ||
[ clientId ] | ||
); | ||
|
||
const images = useMemo( () => { | ||
return getImagesFromBlock( block, isExpanded ); | ||
}, [ block, isExpanded ] ); | ||
|
||
return images; | ||
} |