@wordpress/block-library 6.0.12 → 6.0.17-next.33ec3857e2.0

package/src/columns/style.scss

@@ -10,10 +10,6 @@
 		flex-wrap: nowrap;
 	}
 
-	&:where(.has-background) {
-		padding: $block-bg-padding--v $block-bg-padding--h;
-	}
-
 	/**
 	* All Columns Alignment
 	*/
@@ -85,8 +81,8 @@
 		> .wp-block-column {
 			// Available space should be divided equally amongst columns.
 			flex-basis: 0;
-			flex-grow: 1;
 
+			flex-grow: 1;
 			// Columns with an explicitly-assigned width should maintain their
 			// `flex-basis` width and not grow.
 			&[style*="flex-basis"] {
@@ -101,6 +97,13 @@
 	}
 }
 
+// Add low specificity default padding to columns blocks with backgrounds.
+:where(.wp-block-columns.has-background) {
+	// Matches paragraph block padding.
+	padding: $block-bg-padding--v $block-bg-padding--h;
+}
+
+
 .wp-block-column {
 	flex-grow: 1;
 

package/src/comment-author-avatar/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-author-avatar",
 	"title": "Comment Author Avatar",
@@ -27,8 +28,12 @@
 		},
 		"color": {
 			"background": true,
-			"text": false,
-			"links": false
+			"text": false
+		},
+		"spacing": {
+			"__experimentalSkipSerialization": true,
+			"margin": true,
+			"padding": true
 		}
 	}
 }

package/src/comment-author-avatar/edit.js

@@ -1,7 +1,11 @@
 /**
  * WordPress dependencies
  */
-import { InspectorControls, useBlockProps } from '@wordpress/block-editor';
+import {
+	InspectorControls,
+	useBlockProps,
+	__experimentalGetSpacingClassesAndStyles as useSpacingProps,
+} from '@wordpress/block-editor';
 import { PanelBody, ResizableBox, RangeControl } from '@wordpress/components';
 import { useEntityProp } from '@wordpress/core-data';
 import { __, _x, isRTL } from '@wordpress/i18n';
@@ -31,6 +35,7 @@ export default function Edit( {
 	const minSize = sizes ? sizes[ 0 ] : 24;
 	const maxSize = sizes ? sizes[ sizes.length - 1 ] : 96;
 	const blockProps = useBlockProps();
+	const spacingProps = useSpacingProps( attributes );
 	const maxSizeBuffer = Math.floor( maxSize * 2.5 );
 
 	const inspectorControls = (
@@ -90,7 +95,7 @@ export default function Edit( {
 	return (
 		<>
 			{ inspectorControls }
-			<div>{ displayAvatar }</div>
+			<div { ...spacingProps }>{ displayAvatar }</div>
 		</>
 	);
 }

package/src/comment-author-avatar/index.php

@@ -25,15 +25,31 @@ function render_block_core_comment_author_avatar( $attributes, $content, $block
 
 	// This is the only way to retreive style and classes on different instances.
 	$wrapper_attributes = WP_Block_Supports::get_instance()->apply_block_supports();
-	$width              = isset( $attributes['width'] ) ? $attributes['width'] : 96;
-	$height             = isset( $attributes['height'] ) ? $attributes['height'] : 96;
-	$styles             = isset( $wrapper_attributes['style'] ) ? $wrapper_attributes['style'] : '';
-	$classes            = isset( $wrapper_attributes['class'] ) ? $wrapper_attributes['class'] : '';
+
+	/**
+	 * We get the spacing attributes and transform the array provided into a string formatted for being applied as a style html tag.
+	 * Good candidate to be moved to a separate function in core.
+	*/
+	$spacing_attributes = isset( $attributes['style']['spacing'] ) ? $attributes['style']['spacing'] : null;
+	if ( isset( $spacing_attributes ) && ! empty( $spacing_attributes ) ) {
+		$spacing_array = array();
+		foreach ( $spacing_attributes as $spacing_attribute_key => $spacing_attribute_value ) {
+			foreach ( $spacing_attribute_value as $position_key => $position_value ) {
+				$spacing_array[] = $spacing_attribute_key . '-' . $position_key . ': ' . $position_value;
+			}
+		}
+		$spacing_string = implode( ';', $spacing_array );
+	}
+
+	$width   = isset( $attributes['width'] ) ? $attributes['width'] : 96;
+	$height  = isset( $attributes['height'] ) ? $attributes['height'] : 96;
+	$styles  = isset( $wrapper_attributes['style'] ) ? $wrapper_attributes['style'] : '';
+	$classes = isset( $wrapper_attributes['class'] ) ? $wrapper_attributes['class'] : '';
 
 	/* translators: %s is the Comment Author name */
 	$alt = sprintf( __( '%s Avatar' ), $comment->comment_author );
 
-	$avatar_string = get_avatar(
+	$avatar_block = get_avatar(
 		$comment,
 		null,
 		'',
@@ -45,7 +61,10 @@ function render_block_core_comment_author_avatar( $attributes, $content, $block
 			'class'      => $classes,
 		)
 	);
-	return $avatar_string;
+	if ( isset( $spacing_attributes ) ) {
+		return sprintf( '<div style="%1s">%2s</div>', esc_attr( $spacing_string ), $avatar_block );
+	}
+	return sprintf( '<div>%1s</div>', $avatar_block );
 }
 
 /**

package/src/comment-author-name/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-author-name",
 	"title": "Comment Author Name",

package/src/comment-content/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-content",
 	"title": "Comment Content",

package/src/comment-date/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-date",
 	"title": "Comment Date",

package/src/comment-edit-link/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-edit-link",
 	"title": "Comment Edit Link",

package/src/comment-edit-link/index.js

@@ -1,7 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { edit as icon } from '@wordpress/icons';
+import { commentEditLink as icon } from '@wordpress/icons';
 
 /**
  * Internal dependencies

package/src/comment-reply-link/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-reply-link",
 	"title": "Comment Reply Link",

package/src/comment-template/block.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/block.json",
 	"apiVersion": 2,
 	"name": "core/comment-template",
 	"title": "Comment Template",
@@ -6,10 +7,11 @@
 	"parent": [ "core/comments-query-loop" ],
 	"description": "Contains the block elements used to render a comment, like the title, date, author, avatar and more.",
 	"textdomain": "default",
-	"usesContext": [ "queryId", "queryPerPage", "postId" ],
+	"usesContext": [ "comments/perPage", "postId" ],
 	"supports": {
 		"reusable": false,
 		"html": false,
 		"align": true
-	}
+	},
+	"style": "wp-block-comment-template"
 }

package/src/comment-template/edit.js

@@ -14,6 +14,11 @@ import {
 import { Spinner } from '@wordpress/components';
 import { store as coreStore } from '@wordpress/core-data';
 
+/**
+ * Internal dependencies
+ */
+import { convertToTree } from './util';
+
 const TEMPLATE = [
 	[ 'core/comment-author-avatar' ],
 	[ 'core/comment-author-name' ],
@@ -23,43 +28,129 @@ const TEMPLATE = [
 	[ 'core/comment-edit-link' ],
 ];
 
-function CommentTemplateInnerBlocks() {
-	const innerBlocksProps = useInnerBlocksProps( {}, { template: TEMPLATE } );
-	return <li { ...innerBlocksProps } />;
+/**
+ * Component which renders the inner blocks of the Comment Template.
+ *
+ * @param {Object} props                    Component props.
+ * @param {Array}  [props.comment]          - A comment object.
+ * @param {Array}  [props.activeComment]    - The block that is currently active.
+ * @param {Array}  [props.setActiveComment] - The setter for activeComment.
+ * @param {Array}  [props.firstBlock]       - First comment in the array.
+ * @param {Array}  [props.blocks]           - Array of blocks returned from
+ *                                          getBlocks() in parent .
+ * @return {WPElement}                 		Inner blocks of the Comment Template
+ */
+function CommentTemplateInnerBlocks( {
+	comment,
+	activeComment,
+	setActiveComment,
+	firstBlock,
+	blocks,
+} ) {
+	const { children, ...innerBlocksProps } = useInnerBlocksProps(
+		{},
+		{ template: TEMPLATE }
+	);
+	return (
+		<li { ...innerBlocksProps }>
+			{ comment === ( activeComment || firstBlock ) ? (
+				children
+			) : (
+				<BlockPreview
+					blocks={ blocks }
+					__experimentalLive
+					__experimentalOnClick={ () => setActiveComment( comment ) }
+				/>
+			) }
+			{ comment?.children?.length > 0 ? (
+				<CommentsList
+					comments={ comment.children }
+					activeComment={ activeComment }
+					setActiveComment={ setActiveComment }
+					blocks={ blocks }
+				/>
+			) : null }
+		</li>
+	);
 }
 
+/**
+ * Component that renders a list of (nested) comments. It is called recursively.
+ *
+ * @param {Object} props                    Component props.
+ * @param {Array}  [props.comments]         - Array of comment objects.
+ * @param {Array}  [props.blockProps]       - Props from parent's `useBlockProps()`.
+ * @param {Array}  [props.activeComment]    - The block that is currently active.
+ * @param {Array}  [props.setActiveComment] - The setter for activeComment.
+ * @param {Array}  [props.blocks]           - Array of blocks returned from
+ *                                          getBlocks() in parent .
+ * @return {WPElement}                 		List of comments.
+ */
+const CommentsList = ( {
+	comments,
+	blockProps,
+	activeComment,
+	setActiveComment,
+	blocks,
+} ) => (
+	<ol { ...blockProps }>
+		{ comments &&
+			comments.map( ( comment ) => (
+				<BlockContextProvider
+					key={ comment.commentId }
+					value={ comment }
+				>
+					<CommentTemplateInnerBlocks
+						comment={ comment }
+						activeComment={ activeComment }
+						setActiveComment={ setActiveComment }
+						blocks={ blocks }
+						firstBlock={ comments[ 0 ] }
+					/>
+				</BlockContextProvider>
+			) ) }
+	</ol>
+);
+
 export default function CommentTemplateEdit( {
 	clientId,
-	context: { postId, queryPerPage },
+	context: { postId, 'comments/perPage': perPage },
 } ) {
 	const blockProps = useBlockProps();
 
-	const [ activeBlockContext, setActiveBlockContext ] = useState();
+	const [ activeComment, setActiveComment ] = useState();
 
-	const { comments, blocks } = useSelect(
+	const { rawComments, blocks } = useSelect(
 		( select ) => {
 			const { getEntityRecords } = select( coreStore );
 			const { getBlocks } = select( blockEditorStore );
 
 			return {
-				comments: getEntityRecords( 'root', 'comment', {
+				rawComments: getEntityRecords( 'root', 'comment', {
 					post: postId,
 					status: 'approve',
-					per_page: queryPerPage,
 					order: 'asc',
+					context: 'embed',
 				} ),
 				blocks: getBlocks( clientId ),
 			};
 		},
-		[ queryPerPage, postId, clientId ]
+		[ postId, clientId ]
 	);
 
-	const blockContexts = useMemo(
-		() => comments?.map( ( comment ) => ( { commentId: comment.id } ) ),
-		[ comments ]
+	// TODO: Replicate the logic used on the server.
+	perPage = perPage || 50;
+
+	// We convert the flat list of comments to tree.
+	// Then, we show only a maximum of `perPage` number of comments.
+	// This is because passing `per_page` to `getEntityRecords()` does not
+	// take into account nested comments.
+	const comments = useMemo(
+		() => convertToTree( rawComments ).slice( 0, perPage ),
+		[ rawComments, perPage ]
 	);
 
-	if ( ! comments ) {
+	if ( ! rawComments ) {
 		return (
 			<p { ...blockProps }>
 				<Spinner />
@@ -72,29 +163,12 @@ export default function CommentTemplateEdit( {
 	}
 
 	return (
-		<ul { ...blockProps }>
-			{ blockContexts &&
-				blockContexts.map( ( blockContext ) => (
-					<BlockContextProvider
-						key={ blockContext.commentId }
-						value={ blockContext }
-					>
-						{ blockContext ===
-						( activeBlockContext || blockContexts[ 0 ] ) ? (
-							<CommentTemplateInnerBlocks />
-						) : (
-							<li>
-								<BlockPreview
-									blocks={ blocks }
-									__experimentalLive
-									__experimentalOnClick={ () =>
-										setActiveBlockContext( blockContext )
-									}
-								/>
-							</li>
-						) }
-					</BlockContextProvider>
-				) ) }
-		</ul>
+		<CommentsList
+			comments={ comments }
+			blockProps={ blockProps }
+			blocks={ blocks }
+			activeComment={ activeComment }
+			setActiveComment={ setActiveComment }
+		/>
 	);
 }

package/src/comment-template/index.php

@@ -5,6 +5,43 @@
  * @package WordPress
  */
 
+/**
+ * Function that recursively renders a list of nested comments.
+ *
+ * @param WP_Comment[] $comments    The array of comments.
+ * @param WP_Block     $block           Block instance.
+ * @return string
+ */
+function block_core_comment_template_render_comments( $comments, $block ) {
+	$content = '';
+	foreach ( $comments as $comment ) {
+
+		$block_content = ( new WP_Block(
+			$block->parsed_block,
+			array(
+				'commentId' => $comment->comment_ID,
+			)
+		) )->render( array( 'dynamic' => false ) );
+
+		$children = $comment->get_children();
+
+		// If the comment has children, recurse to create the HTML for the nested
+		// comments.
+		if ( ! empty( $children ) ) {
+			$inner_content  = block_core_comment_template_render_comments(
+				$children,
+				$block
+			);
+			$block_content .= sprintf( '<ol>%1$s</ol>', $inner_content );
+		}
+
+		$content .= '<li>' . $block_content . '</li>';
+	}
+
+	return $content;
+
+}
+
 /**
  * Renders the `core/comment-template` block on the server.
  *
@@ -16,37 +53,27 @@
  * defined by the block's inner blocks.
  */
 function render_block_core_comment_template( $attributes, $content, $block ) {
-
-	$post_id = $block->context['postId'];
-
 	// Bail out early if the post ID is not set for some reason.
-	if ( ! isset( $post_id ) ) {
+	if ( empty( $block->context['postId'] ) ) {
 		return '';
 	}
 
-	$number = $block->context['queryPerPage'];
+	$comment_query = new WP_Comment_Query(
+		build_comment_query_vars_from_block( $block )
+	);
 
 	// Get an array of comments for the current post.
-	$comments = get_approved_comments( $post_id, array( 'number' => $number ) );
-
+	$comments = $comment_query->get_comments();
 	if ( count( $comments ) === 0 ) {
 		return '';
 	}
 
-	$content = '';
-	foreach ( $comments as $comment ) {
-		$block_content = ( new WP_Block(
-			$block->parsed_block,
-			array(
-				'commentId' => $comment->comment_ID,
-			)
-		) )->render( array( 'dynamic' => false ) );
-		$content      .= '<li>' . $block_content . '</li>';
-	}
+	$wrapper_attributes = get_block_wrapper_attributes();
 
 	return sprintf(
-		'<ul>%1$s</ul>',
-		$content
+		'<ol %1$s>%2$s</ol>',
+		$wrapper_attributes,
+		block_core_comment_template_render_comments( $comments, $block )
 	);
 }
 

package/src/comment-template/style.scss

@@ -0,0 +1,17 @@
+.wp-block-comment-template {
+	margin-bottom: 0;
+	max-width: 100%;
+	list-style: none;
+	padding: 0;
+
+	li {
+		clear: both;
+	}
+
+	ol {
+		margin-bottom: 0;
+		max-width: 100%;
+		list-style: none;
+		padding-left: 2rem;
+	}
+}

package/src/comment-template/test/index.js

@@ -0,0 +1,45 @@
+/**
+ * Internal dependencies
+ */
+import { convertToTree } from '../util';
+
+describe( 'Convert to tree', () => {
+	it( 'Empty comments', () => {
+		const comments = convertToTree( [] );
+
+		expect( comments ).toEqual( [] );
+	} );
+
+	it( 'Handle comments', () => {
+		const comments = convertToTree( [
+			{ id: 1, parent: 0 },
+			{ id: 2, parent: 0 },
+			{ id: 3, parent: 2 },
+			{ id: 4, parent: 2 },
+			{ id: 5, parent: 4 },
+			{ id: 6, parent: 1 },
+		] );
+
+		expect( comments ).toEqual( [
+			{
+				commentId: 1,
+				children: [
+					{
+						commentId: 6,
+						children: [],
+					},
+				],
+			},
+			{
+				commentId: 2,
+				children: [
+					{ commentId: 3, children: [] },
+					{
+						commentId: 4,
+						children: [ { commentId: 5, children: [] } ],
+					},
+				],
+			},
+		] );
+	} );
+} );

package/src/comment-template/util.js

@@ -0,0 +1,56 @@
+/**
+ *
+ * This function converts a flat list of comment objects with a `parent` property
+ * to a nested list of comment objects with a `children` property. The `children`
+ * property is itself a list of comment objects.
+ *
+ * @example
+ * ```
+ * const comments = [
+ * 	{ id: 1, parent: 0 },
+ * 	{ id: 2, parent: 1 },
+ * 	{ id: 3, parent: 2 },
+ * 	{ id: 4, parent: 1 },
+ * ];
+ * expect( convertToTree( comments ) ).toEqual( [
+ * 	{
+ * 		commentId: 1,
+ * 		children: [
+ * 			{ commentId: 2, children: [ { commentId: 3, children: [] } ] },
+ * 			{ commentId: 4, children: [] },
+ * 		],
+ * 	},
+ * ] );
+ * ```
+ * @typedef {{id: number, parent: number}} Comment
+ * @param {Comment[]} data - List of comment objects.
+ *
+ * @return {Object[]} Nested list of comment objects with a `children` property.
+ */
+export const convertToTree = ( data ) => {
+	const table = {};
+	if ( ! data ) return [];
+
+	// First create a hash table of { [id]: { ...comment, children: [] }}
+	data.forEach( ( item ) => {
+		table[ item.id ] = { commentId: item.id, children: [] };
+	} );
+
+	const tree = [];
+
+	// Iterate over the original comments again
+	data.forEach( ( item ) => {
+		if ( item.parent ) {
+			// If the comment has a "parent", then find that parent in the table that
+			// we have created above and push the current comment to the array of its
+			// children.
+			table[ item.parent ].children.push( table[ item.id ] );
+		} else {
+			// Otherwise, if the comment has no parent (also works if parent is 0)
+			// that means that it's a top-level comment so we can find it in the table
+			// and push it to the final tree.
+			tree.push( table[ item.id ] );
+		}
+	} );
+	return tree;
+};

package/src/comments-pagination/block.json

@@ -0,0 +1,37 @@
+{
+	"$schema": "https://schemas.wp.org/trunk/block.json",
+	"apiVersion": 2,
+	"name": "core/comments-pagination",
+	"title": "Comments Pagination",
+	"category": "design",
+	"parent": [ "core/comments-query-loop" ],
+	"description": "Displays a paginated navigation to next/previous set of comments, when applicable.",
+	"textdomain": "default",
+	"attributes": {
+		"paginationArrow": {
+			"type": "string",
+			"default": "none"
+		}
+	},
+	"providesContext": {
+		"paginationArrow": "paginationArrow"
+	},
+	"supports": {
+		"align": true,
+		"reusable": false,
+		"html": false,
+		"color": {
+			"gradients": true,
+			"link": true
+		},
+		"__experimentalLayout": {
+			"allowSwitching": false,
+			"allowInheriting": false,
+			"default": {
+				"type": "flex"
+			}
+		}
+	},
+	"editorStyle": "wp-block-comments-pagination-editor",
+	"style": "wp-block-comments-pagination"
+}

package/src/comments-pagination/comments-pagination-arrow-controls.js

@@ -0,0 +1,44 @@
+/**
+ * WordPress dependencies
+ */
+import { __, _x } from '@wordpress/i18n';
+import {
+	__experimentalToggleGroupControl as ToggleGroupControl,
+	__experimentalToggleGroupControlOption as ToggleGroupControlOption,
+} from '@wordpress/components';
+
+export function CommentsPaginationArrowControls( { value, onChange } ) {
+	return (
+		<ToggleGroupControl
+			label={ __( 'Arrow' ) }
+			value={ value }
+			onChange={ onChange }
+			help={ __(
+				'A decorative arrow appended to the next and previous comments link.'
+			) }
+			isBlock
+		>
+			<ToggleGroupControlOption
+				value="none"
+				label={ _x(
+					'None',
+					'Arrow option for Comments Pagination Next/Previous blocks'
+				) }
+			/>
+			<ToggleGroupControlOption
+				value="arrow"
+				label={ _x(
+					'Arrow',
+					'Arrow option for Comments Pagination Next/Previous blocks'
+				) }
+			/>
+			<ToggleGroupControlOption
+				value="chevron"
+				label={ _x(
+					'Chevron',
+					'Arrow option for Comments Pagination Next/Previous blocks'
+				) }
+			/>
+		</ToggleGroupControl>
+	);
+}