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 Navigation Links wrapper block #30430

Closed
wants to merge 2 commits into from
Closed
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
2 changes: 2 additions & 0 deletions lib/blocks.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ function gutenberg_reregister_core_block_types() {
'missing',
'more',
'navigation-link',
'navigation-link-list',
'nextpage',
'paragraph',
'preformatted',
Expand Down Expand Up @@ -61,6 +62,7 @@ function gutenberg_reregister_core_block_types() {
'navigation.php' => 'core/navigation',
'navigation-link.php' => 'core/navigation-link',
'home-link.php' => 'core/home-link',
'navigation-link-list.php' => 'core/navigation-link-list',
'rss.php' => 'core/rss',
'search.php' => 'core/search',
'shortcode.php' => 'core/shortcode',
Expand Down
2 changes: 2 additions & 0 deletions packages/block-library/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import * as html from './html';
import * as mediaText from './media-text';
import * as navigation from './navigation';
import * as navigationLink from './navigation-link';
import * as navigationLinkList from './navigation-link-list';
import * as homeLink from './home-link';
import * as latestComments from './latest-comments';
import * as latestPosts from './latest-posts';
Expand Down Expand Up @@ -234,6 +235,7 @@ export const __experimentalRegisterExperimentalCoreBlocks =
[
navigation,
navigationLink,
navigationLinkList,
homeLink,

// Register Legacy Widget block.
Expand Down
12 changes: 12 additions & 0 deletions packages/block-library/src/navigation-link-list/block.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"apiVersion": 2,
"name": "core/navigation-link-list",
"category": "design",
"parent": [ "core/navigation" ],
"supports": {
"reusable": false,
"html": false
},
"editorStyle": "wp-block-navigation-link-list-editor",
"style": "wp-block-navigation-link-list"
}
68 changes: 68 additions & 0 deletions packages/block-library/src/navigation-link-list/edit.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/**
* WordPress dependencies
*/
import {
InnerBlocks,
BlockControls,
InspectorControls,
useBlockProps,
__experimentalUseInnerBlocksProps as useInnerBlocksProps,
store as blockEditorStore,
} from '@wordpress/block-editor';
import { useSelect } from '@wordpress/data';

const ALLOWED_BLOCKS = [ 'core/navigation-link', 'core/spacer' ];

export default function NavigationLinksEdit( { clientId, isSelected } ) {
const {
isImmediateParentOfSelectedBlock,
selectedBlockHasDescendants,
} = useSelect(
( select ) => {
const {
getClientIdsOfDescendants,
hasSelectedInnerBlock,
getSelectedBlockClientId,
} = select( blockEditorStore );
const selectedBlockId = getSelectedBlockClientId();
return {
isImmediateParentOfSelectedBlock: hasSelectedInnerBlock(
clientId,
false
),
selectedBlockHasDescendants: !! getClientIdsOfDescendants( [
selectedBlockId,
] )?.length,
};
},
[ clientId ]
);

const blockProps = useBlockProps( {
className: 'wp-block-navigation__container',
} );

const innerBlocksProps = useInnerBlocksProps( blockProps, {
allowedBlocks: ALLOWED_BLOCKS,
renderAppender:
( isImmediateParentOfSelectedBlock &&
! selectedBlockHasDescendants ) ||
isSelected
? InnerBlocks.DefaultAppender
: false,
__experimentalAppenderTagName: 'li',
__experimentalCaptureToolbars: true,
__experimentalLayout: {
type: 'default',
alignments: [],
},
} );

return (
<>
<BlockControls />
<InspectorControls />
<ul { ...innerBlocksProps } />
</>
);
}
30 changes: 30 additions & 0 deletions packages/block-library/src/navigation-link-list/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
* WordPress dependencies
*/
import { __, _x } from '@wordpress/i18n';
import { customLink as linkIcon } from '@wordpress/icons';

/**
* Internal dependencies
*/
import metadata from './block.json';
import edit from './edit';
import save from './save';

const { name } = metadata;

export { metadata, name };

export const settings = {
title: _x( 'List of links', 'block title' ),

icon: linkIcon,

description: __( 'Add a list of links to your navigation.' ),

keywords: [ __( 'links' ) ],

edit,

save,
};
38 changes: 38 additions & 0 deletions packages/block-library/src/navigation-link-list/index.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php
/**
* Renders the `core/navigation-link-list` block on server.
*
* @param array $block The parsed block.
*
* @return string Returns the block html.
*/
function render_block_core_navigation_link_list( $attributes, $content, $block ) {

if ( empty( $block->inner_blocks ) ) {
return '';
}

$inner_blocks_html = '';
foreach ( $block->inner_blocks as $inner_block ) {
$inner_blocks_html .= $inner_block->render();
}

return sprintf('<ul class="wp-block-navigation__container">%1$s</ul>', $inner_blocks_html);
}

/**
* Register the navigation link list block.
*
* @uses render_block_core_navigation_link_list()
* @throws WP_Error An WP_Error exception parsing the block definition.
*/
function register_block_core_navigation_link_list() {
register_block_type_from_metadata(
__DIR__ . '/navigation-link-list',
array(
'render_callback' => 'render_block_core_navigation_link_list',
)
);
}

add_action( 'init', 'register_block_core_navigation_link_list' );
8 changes: 8 additions & 0 deletions packages/block-library/src/navigation-link-list/save.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/**
* WordPress dependencies
*/
import { InnerBlocks } from '@wordpress/block-editor';

export default function save() {
return <InnerBlocks.Content />;
}
4 changes: 1 addition & 3 deletions packages/block-library/src/navigation-link/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
"name": "core/navigation-link",
"title": "Custom Link",
"category": "design",
"parent": [
"core/navigation"
],
"parent": [ "core/navigation-link-list" ],
"description": "Add a page, link, or another item to your navigation.",
"textdomain": "default",
"attributes": {
Expand Down
4 changes: 2 additions & 2 deletions packages/block-library/src/navigation/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import PlaceholderPreview from './placeholder-preview';
import ResponsiveWrapper from './responsive-wrapper';

const ALLOWED_BLOCKS = [
'core/navigation-link',
'core/navigation-link-list',
'core/search',
'core/social-links',
'core/page-list',
Expand Down Expand Up @@ -173,7 +173,7 @@ function Navigation( {
isOpen={ isResponsiveMenuOpen }
isResponsive={ attributes.isResponsive }
>
<ul { ...innerBlocksProps }></ul>
<div { ...innerBlocksProps }></div>
</ResponsiveWrapper>
</nav>
</>
Expand Down
2 changes: 1 addition & 1 deletion packages/block-library/src/navigation/placeholder.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ function NavigationPlaceholder( { onCreate }, ref ) {
};

const onCreateEmptyMenu = () => {
onCreate( [] );
onCreate( [ createBlock( 'core/navigation-link-list' ) ] );
};

const onCreateAllPages = () => {
Expand Down