@wordpress/block-library 5.0.1 → 6.0.1

package/src/navigation-submenu/index.js

@@ -0,0 +1,29 @@
+/**
+ * WordPress dependencies
+ */
+import { addSubmenu } from '@wordpress/icons';
+
+/**
+ * Internal dependencies
+ */
+
+import metadata from './block.json';
+import edit from './edit';
+import save from './save';
+import transforms from './transforms';
+
+const { name } = metadata;
+
+export { metadata, name };
+
+export const settings = {
+	icon: addSubmenu,
+
+	__experimentalLabel: ( { label } ) => label,
+
+	edit,
+
+	save,
+
+	transforms,
+};

package/src/navigation-submenu/index.php

@@ -0,0 +1,299 @@
+<?php
+/**
+ * Server-side rendering of the `core/navigation-submenu` block.
+ *
+ * @package gutenberg
+ */
+
+/**
+ * Build an array with CSS classes and inline styles defining the colors
+ * which will be applied to the navigation markup in the front-end.
+ *
+ * @param  array $context    Navigation block context.
+ * @param  array $attributes Block attributes.
+ * @return array Colors CSS classes and inline styles.
+ */
+function block_core_navigation_submenu_build_css_colors( $context, $attributes ) {
+	$colors = array(
+		'css_classes'   => array(),
+		'inline_styles' => '',
+	);
+
+	$is_sub_menu = isset( $attributes['isTopLevelLink'] ) ? ( ! $attributes['isTopLevelLink'] ) : false;
+
+	// Text color.
+	$named_text_color  = null;
+	$custom_text_color = null;
+
+	if ( $is_sub_menu && array_key_exists( 'customOverlayTextColor', $context ) ) {
+		$custom_text_color = $context['customOverlayTextColor'];
+	} elseif ( $is_sub_menu && array_key_exists( 'overlayTextColor', $context ) ) {
+		$named_text_color = $context['overlayTextColor'];
+	} elseif ( array_key_exists( 'customTextColor', $context ) ) {
+		$custom_text_color = $context['customTextColor'];
+	} elseif ( array_key_exists( 'textColor', $context ) ) {
+		$named_text_color = $context['textColor'];
+	} elseif ( isset( $context['style']['color']['text'] ) ) {
+		$custom_text_color = $context['style']['color']['text'];
+	}
+
+	// If has text color.
+	if ( ! is_null( $named_text_color ) ) {
+		// Add the color class.
+		array_push( $colors['css_classes'], 'has-text-color', sprintf( 'has-%s-color', $named_text_color ) );
+	} elseif ( ! is_null( $custom_text_color ) ) {
+		// Add the custom color inline style.
+		$colors['css_classes'][]  = 'has-text-color';
+		$colors['inline_styles'] .= sprintf( 'color: %s;', $custom_text_color );
+	}
+
+	// Background color.
+	$named_background_color  = null;
+	$custom_background_color = null;
+
+	if ( $is_sub_menu && array_key_exists( 'customOverlayBackgroundColor', $context ) ) {
+		$custom_background_color = $context['customOverlayBackgroundColor'];
+	} elseif ( $is_sub_menu && array_key_exists( 'overlayBackgroundColor', $context ) ) {
+		$named_background_color = $context['overlayBackgroundColor'];
+	} elseif ( array_key_exists( 'customBackgroundColor', $context ) ) {
+		$custom_background_color = $context['customBackgroundColor'];
+	} elseif ( array_key_exists( 'backgroundColor', $context ) ) {
+		$named_background_color = $context['backgroundColor'];
+	} elseif ( isset( $context['style']['color']['background'] ) ) {
+		$custom_background_color = $context['style']['color']['background'];
+	}
+
+	// If has background color.
+	if ( ! is_null( $named_background_color ) ) {
+		// Add the background-color class.
+		array_push( $colors['css_classes'], 'has-background', sprintf( 'has-%s-background-color', $named_background_color ) );
+	} elseif ( ! is_null( $custom_background_color ) ) {
+		// Add the custom background-color inline style.
+		$colors['css_classes'][]  = 'has-background';
+		$colors['inline_styles'] .= sprintf( 'background-color: %s;', $custom_background_color );
+	}
+
+	return $colors;
+}
+
+/**
+ * Build an array with CSS classes and inline styles defining the font sizes
+ * which will be applied to the navigation markup in the front-end.
+ *
+ * @param  array $context Navigation block context.
+ * @return array Font size CSS classes and inline styles.
+ */
+function block_core_navigation_submenu_build_css_font_sizes( $context ) {
+	// CSS classes.
+	$font_sizes = array(
+		'css_classes'   => array(),
+		'inline_styles' => '',
+	);
+
+	$has_named_font_size  = array_key_exists( 'fontSize', $context );
+	$has_custom_font_size = isset( $context['style']['typography']['fontSize'] );
+
+	if ( $has_named_font_size ) {
+		// Add the font size class.
+		$font_sizes['css_classes'][] = sprintf( 'has-%s-font-size', $context['fontSize'] );
+	} elseif ( $has_custom_font_size ) {
+		// Add the custom font size inline style.
+		$font_sizes['inline_styles'] = sprintf( 'font-size: %spx;', $context['style']['typography']['fontSize'] );
+	}
+
+	return $font_sizes;
+}
+
+/**
+ * Returns the top-level submenu SVG chevron icon.
+ *
+ * @return string
+ */
+function block_core_navigation_submenu_render_submenu_icon() {
+	return '<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none" role="img" aria-hidden="true" focusable="false"><path d="M1.50002 4L6.00002 8L10.5 4" stroke-width="1.5"></path></svg>';
+}
+
+/**
+ * Renders the `core/navigation-submenu` block.
+ *
+ * @param array $attributes The block attributes.
+ * @param array $content The saved content.
+ * @param array $block The parsed block.
+ *
+ * @return string Returns the post content with the legacy widget added.
+ */
+function render_block_core_navigation_submenu( $attributes, $content, $block ) {
+
+	$navigation_link_has_id = isset( $attributes['id'] ) && is_numeric( $attributes['id'] );
+	$is_post_type           = isset( $attributes['kind'] ) && 'post-type' === $attributes['kind'];
+	$is_post_type           = $is_post_type || isset( $attributes['type'] ) && ( 'post' === $attributes['type'] || 'page' === $attributes['type'] );
+
+	// Don't render the block's subtree if it is a draft.
+	if ( $is_post_type && $navigation_link_has_id ) {
+		$post = get_post( $attributes['id'] );
+		if ( 'publish' !== $post->post_status ) {
+			return '';
+		}
+	}
+
+	// Don't render the block's subtree if it has no label.
+	if ( empty( $attributes['label'] ) ) {
+		return '';
+	}
+
+	$colors          = block_core_navigation_submenu_build_css_colors( $block->context, $attributes );
+	$font_sizes      = block_core_navigation_submenu_build_css_font_sizes( $block->context );
+	$classes         = array_merge(
+		$colors['css_classes'],
+		$font_sizes['css_classes']
+	);
+	$style_attribute = ( $colors['inline_styles'] . $font_sizes['inline_styles'] );
+
+	$css_classes = trim( implode( ' ', $classes ) );
+	$has_submenu = count( $block->inner_blocks ) > 0;
+	$is_active   = ! empty( $attributes['id'] ) && ( get_the_ID() === $attributes['id'] );
+
+	$class_name = ! empty( $attributes['className'] ) ? implode( ' ', (array) $attributes['className'] ) : false;
+
+	if ( false !== $class_name ) {
+		$css_classes .= ' ' . $class_name;
+	}
+
+	$show_submenu_indicators = isset( $block->context['showSubmenuIcon'] ) && $block->context['showSubmenuIcon'];
+	$open_on_click           = isset( $block->context['openSubmenusOnClick'] ) && $block->context['openSubmenusOnClick'];
+	$open_on_hover_and_click = isset( $block->context['openSubmenusOnClick'] ) && ! $block->context['openSubmenusOnClick'] &&
+		$show_submenu_indicators;
+
+	$wrapper_attributes = get_block_wrapper_attributes(
+		array(
+			'class' => $css_classes . ' wp-block-navigation-item' . ( $has_submenu ? ' has-child' : '' ) .
+			( $open_on_click ? ' open-on-click' : '' ) . ( $open_on_hover_and_click ? ' open-on-hover-click' : '' ) .
+			( $is_active ? ' current-menu-item' : '' ),
+			'style' => $style_attribute,
+		)
+	);
+	$html               = '<li ' . $wrapper_attributes . '>';
+
+	// If Submenus open on hover, we render an anchor tag with attributes.
+	// If submenu icons are set to show, we also render a submenu button, so the submenu can be opened on click.
+	if ( ! $open_on_click ) {
+		$item_url = isset( $attributes['url'] ) ? esc_url( $attributes['url'] ) : '';
+		// Start appending HTML attributes to anchor tag.
+		$html .= '<a class="wp-block-navigation-item__content" href="' . $item_url . '"';
+
+		if ( isset( $attributes['opensInNewTab'] ) && true === $attributes['opensInNewTab'] ) {
+			$html .= ' target="_blank"  ';
+		}
+
+		if ( isset( $attributes['rel'] ) ) {
+			$html .= ' rel="' . esc_attr( $attributes['rel'] ) . '"';
+		} elseif ( isset( $attributes['nofollow'] ) && $attributes['nofollow'] ) {
+			$html .= ' rel="nofollow"';
+		}
+
+		if ( isset( $attributes['title'] ) ) {
+			$html .= ' title="' . esc_attr( $attributes['title'] ) . '"';
+		}
+
+		$html .= '>';
+		// End appending HTML attributes to anchor tag.
+
+		if ( isset( $attributes['label'] ) ) {
+			$html .= wp_kses(
+				$attributes['label'],
+				array(
+					'code'   => array(),
+					'em'     => array(),
+					'img'    => array(
+						'scale' => array(),
+						'class' => array(),
+						'style' => array(),
+						'src'   => array(),
+						'alt'   => array(),
+					),
+					's'      => array(),
+					'span'   => array(
+						'style' => array(),
+					),
+					'strong' => array(),
+				)
+			);
+		}
+
+		$html .= '</a>';
+		// End anchor tag content.
+
+		if ( $show_submenu_indicators ) {
+			// The submenu icon is rendered in a button here
+			// so that there's a clickable elment to open the submenu.
+			$html .= '<button class="wp-block-navigation__submenu-icon wp-block-navigation-submenu__toggle" aria-expanded="false">' . block_core_navigation_submenu_render_submenu_icon() . '</button>';
+		}
+	} else {
+		// If menus open on click, we render the parent as a button.
+		$html .= '<button class="wp-block-navigation-item__content wp-block-navigation-submenu__toggle" aria-expanded="false">';
+
+		// Wrap title with span to isolate it from submenu icon.
+		$html .= '<span class="wp-block-navigation-link__label">';
+
+		if ( isset( $attributes['label'] ) ) {
+			$html .= wp_kses(
+				$attributes['label'],
+				array(
+					'code'   => array(),
+					'em'     => array(),
+					'img'    => array(
+						'scale' => array(),
+						'class' => array(),
+						'style' => array(),
+						'src'   => array(),
+						'alt'   => array(),
+					),
+					's'      => array(),
+					'span'   => array(
+						'style' => array(),
+					),
+					'strong' => array(),
+				)
+			);
+		}
+
+		$html .= '</span>';
+
+		$html .= '<span class="wp-block-navigation__submenu-icon">' . block_core_navigation_submenu_render_submenu_icon() . '</span>';
+
+		$html .= '</button>';
+
+	}
+
+	if ( $has_submenu ) {
+		$inner_blocks_html = '';
+		foreach ( $block->inner_blocks as $inner_block ) {
+			$inner_blocks_html .= $inner_block->render();
+		}
+
+		$html .= sprintf(
+			'<ul class="wp-block-navigation__submenu-container">%s</ul>',
+			$inner_blocks_html
+		);
+	}
+
+	$html .= '</li>';
+
+	return $html;
+}
+
+/**
+ * Register the navigation submenu block.
+ *
+ * @uses render_block_core_navigation_submenu()
+ * @throws WP_Error An WP_Error exception parsing the block definition.
+ */
+function register_block_core_navigation_submenu() {
+	register_block_type_from_metadata(
+		__DIR__ . '/navigation-submenu',
+		array(
+			'render_callback' => 'render_block_core_navigation_submenu',
+		)
+	);
+}
+add_action( 'init', 'register_block_core_navigation_submenu' );

package/src/navigation-submenu/save.js

@@ -0,0 +1,8 @@
+/**
+ * WordPress dependencies
+ */
+import { InnerBlocks } from '@wordpress/block-editor';
+
+export default function save() {
+	return <InnerBlocks.Content />;
+}

package/src/navigation-submenu/style.scss

@@ -0,0 +1,20 @@
+.wp-block-navigation-submenu {
+	position: relative;
+	display: flex;
+
+	.wp-block-navigation__submenu-icon svg {
+		stroke: currentColor;
+	}
+}
+
+button.wp-block-navigation-item__content {
+	background-color: transparent;
+	border: none;
+	color: currentColor;
+	font-size: inherit;
+	font-family: inherit;
+}
+
+.wp-block-navigation-submenu__toggle {
+	cursor: pointer;
+}

package/src/navigation-submenu/transforms.js

@@ -0,0 +1,58 @@
+/**
+ * WordPress dependencies
+ */
+import { createBlock } from '@wordpress/blocks';
+
+const transforms = {
+	to: [
+		{
+			type: 'block',
+			blocks: [ 'core/navigation-link' ],
+			isMatch: ( attributes, block ) => block?.innerBlocks?.length === 0,
+			transform: ( attributes ) =>
+				createBlock( 'core/navigation-link', attributes ),
+		},
+		{
+			type: 'block',
+			blocks: [ 'core/spacer' ],
+			isMatch: ( attributes, block ) => block?.innerBlocks?.length === 0,
+			transform: () => {
+				return createBlock( 'core/spacer' );
+			},
+		},
+		{
+			type: 'block',
+			blocks: [ 'core/site-logo' ],
+			isMatch: ( attributes, block ) => block?.innerBlocks?.length === 0,
+			transform: () => {
+				return createBlock( 'core/site-logo' );
+			},
+		},
+		{
+			type: 'block',
+			blocks: [ 'core/home-link' ],
+			isMatch: ( attributes, block ) => block?.innerBlocks?.length === 0,
+			transform: () => {
+				return createBlock( 'core/home-link' );
+			},
+		},
+		{
+			type: 'block',
+			blocks: [ 'core/social-links' ],
+			isMatch: ( attributes, block ) => block?.innerBlocks?.length === 0,
+			transform: () => {
+				return createBlock( 'core/social-links' );
+			},
+		},
+		{
+			type: 'block',
+			blocks: [ 'core/search' ],
+			isMatch: ( attributes, block ) => block?.innerBlocks?.length === 0,
+			transform: () => {
+				return createBlock( 'core/search' );
+			},
+		},
+	],
+};
+
+export default transforms;

package/src/navigation-submenu/view.js

@@ -0,0 +1,62 @@
+const closeSubmenus = ( element ) => {
+	element
+		.querySelectorAll( '[aria-expanded="true"]' )
+		.forEach( ( toggle ) => {
+			toggle.setAttribute( 'aria-expanded', 'false' );
+		} );
+};
+
+const toggleSubmenuOnClick = ( event ) => {
+	const buttonToggle = event.target.closest( '[aria-expanded]' );
+	const isSubmenuOpen = buttonToggle.getAttribute( 'aria-expanded' );
+
+	if ( isSubmenuOpen === 'true' ) {
+		closeSubmenus( buttonToggle.closest( '.wp-block-navigation-submenu' ) );
+	} else {
+		// Close all sibling submenus.
+		const parentElement = buttonToggle.closest(
+			'.wp-block-navigation-submenu'
+		);
+		const parentList =
+			buttonToggle.closest( '.wp-block-navigation__submenu-container' ) ||
+			buttonToggle.closest( '.wp-block-navigation__container' );
+		Array.from( parentList.children ).forEach( ( child ) => {
+			if ( child !== parentElement ) {
+				closeSubmenus( child );
+			}
+		} );
+		// Open submenu.
+		buttonToggle.setAttribute( 'aria-expanded', 'true' );
+	}
+};
+
+const submenuButtons = document.querySelectorAll(
+	'.wp-block-navigation-submenu__toggle'
+);
+
+submenuButtons.forEach( ( button ) => {
+	button.addEventListener( 'click', toggleSubmenuOnClick );
+} );
+
+// Close on click outside.
+document.addEventListener( 'click', function ( event ) {
+	const navigationBlocks = document.querySelectorAll(
+		'.wp-block-navigation'
+	);
+	navigationBlocks.forEach( ( block ) => {
+		if ( ! block.contains( event.target ) ) {
+			closeSubmenus( block );
+		}
+	} );
+} );
+// Close on focus outside.
+document.addEventListener( 'keyup', function ( event ) {
+	const submenuBlocks = document.querySelectorAll(
+		'.wp-block-navigation-submenu'
+	);
+	submenuBlocks.forEach( ( block ) => {
+		if ( ! block.contains( event.target ) ) {
+			closeSubmenus( block );
+		}
+	} );
+} );

package/src/page-list/block.json

@@ -30,6 +30,15 @@
 		},
 		"customOverlayTextColor": {
 			"type": "string"
+		},
+		"isNavigationChild": {
+			"type": "boolean"
+		},
+		"showSubmenuIcon": {
+			"type": "boolean"
+		},
+		"openSubmenusOnClick" : {
+			"type": "boolean"
 		}
 	},
 	"usesContext": [
@@ -44,7 +53,8 @@
 		"fontSize",
 		"customFontSize",
 		"showSubmenuIcon",
-		"style"
+		"style",
+		"openSubmenusOnClick"
 	],
 	"supports": {
 		"reusable": false,

package/src/page-list/convert-to-links-modal.js

@@ -50,6 +50,26 @@ export const convertSelectedBlockToNavigationLinks = ( {
 		}
 	} );
 
+	// Transform all links with innerBlocks into Submenus. This can't be done
+	// sooner because page objects have no information on their children.
+
+	const transformSubmenus = ( listOfLinks ) => {
+		listOfLinks.forEach( ( block, index, listOfLinksArray ) => {
+			const { attributes, innerBlocks } = block;
+			if ( innerBlocks.length !== 0 ) {
+				transformSubmenus( innerBlocks );
+				const transformedBlock = createBlock(
+					'core/navigation-submenu',
+					attributes,
+					innerBlocks
+				);
+				listOfLinksArray[ index ] = transformedBlock;
+			}
+		} );
+	};
+
+	transformSubmenus( navigationLinks );
+
 	replaceBlock( clientId, navigationLinks );
 };
 

package/src/page-list/edit.js

@@ -69,8 +69,7 @@ export default function PageListEdit( {
 		context.customOverlayBackgroundColor,
 	] );
 
-	const { textColor, backgroundColor, showSubmenuIcon, style } =
-		context || {};
+	const { textColor, backgroundColor, style } = context || {};
 
 	const [ allowConvertToLinks, setAllowConvertToLinks ] = useState( false );
 
@@ -83,7 +82,6 @@ export default function PageListEdit( {
 				'background-color',
 				backgroundColor
 			) ]: !! backgroundColor,
-			'show-submenu-icons': !! showSubmenuIcon,
 		} ),
 		style: { ...style?.color },
 	} );
@@ -99,6 +97,14 @@ export default function PageListEdit( {
 		[ clientId ]
 	);
 
+	useEffect( () => {
+		setAttributes( {
+			isNavigationChild: isParentNavigation,
+			openSubmenusOnClick: !! context.openSubmenusOnClick,
+			showSubmenuIcon: !! context.showSubmenuIcon,
+		} );
+	}, [ context.openSubmenusOnClick, context.showSubmenuIcon ] );
+
 	useEffect( () => {
 		if ( isParentNavigation ) {
 			apiFetch( {
@@ -121,6 +127,14 @@ export default function PageListEdit( {
 	const openModal = () => setOpen( true );
 	const closeModal = () => setOpen( false );
 
+	// Update parent status before component first renders.
+	const attributesWithParentStatus = {
+		...attributes,
+		isNavigationChild: isParentNavigation,
+		openSubmenusOnClick: !! context.openSubmenusOnClick,
+		showSubmenuIcon: !! context.showSubmenuIcon,
+	};
+
 	return (
 		<>
 			{ allowConvertToLinks && (
@@ -139,7 +153,7 @@ export default function PageListEdit( {
 			<div { ...blockProps }>
 				<ServerSideRender
 					block="core/page-list"
-					attributes={ attributes }
+					attributes={ attributesWithParentStatus }
 				/>
 			</div>
 		</>

package/src/page-list/editor.scss

@@ -50,3 +50,17 @@
 		margin-left: $grid-unit-15;
 	}
 }
+
+// Simulate open on click behaviour in the editor by opening on focus instead.
+
+.wp-block-page-list {
+	.open-on-click:focus-within {
+		> .wp-block-navigation__submenu-container {
+			visibility: visible;
+			opacity: 1;
+			width: auto;
+			height: auto;
+			min-width: 200px;
+		}
+	}
+}