diff --git a/bin/api-docs/gen-block-lib-list.js b/bin/api-docs/gen-block-lib-list.js index 60b0a99b096ab8..90b6b808941896 100644 --- a/bin/api-docs/gen-block-lib-list.js +++ b/bin/api-docs/gen-block-lib-list.js @@ -155,14 +155,20 @@ function readBlockJSON( filename ) { ? processObjWithInnerKeys( augmentSupports( blockjson.supports ) ) : []; const attributes = getTruthyKeys( blockjson.attributes ); + const parent = blockjson.parent + ? '\n' + `- **Parent:** ${ blockjson.parent.join( ', ' ) }` + : ''; + const experimental = blockjson.__experimental + ? '\n' + `- **Experimental:** ${ blockjson.__experimental }` + : ''; return ` ## ${ blockjson.title } ${ blockjson.description } ([Source](${ sourcefile })) -- **Name:** ${ blockjson.name } -- **Category:** ${ blockjson.category } +- **Name:** ${ blockjson.name }${ experimental } +- **Category:** ${ blockjson.category }${ parent } - **Supports:** ${ supportsList.sort().join( ', ' ) } - **Attributes:** ${ attributes.sort().join( ', ' ) } `; diff --git a/docs/reference-guides/core-blocks.md b/docs/reference-guides/core-blocks.md index 423676e2afe320..c3099d0b898465 100644 --- a/docs/reference-guides/core-blocks.md +++ b/docs/reference-guides/core-blocks.md @@ -1,10 +1,11 @@ # Core Blocks Reference -This page lists the core blocks included in the block-library package. +This page lists the blocks included in the block-library package. + +- Items marked with a strikeout (~~strikeout~~) are explicitly disabled. +- Blocks marked with **Experimental:** true are only available when Gutenberg is active. +- Blocks marked with **Experimental:** fse are only available in the Site Editor. -
-Items marked with a strikeout (~~strikeout~~) are explicitly disabled. -
@@ -50,6 +51,7 @@ Prompt visitors to take action with a button-style link. ([Source](https://githu - **Name:** core/button - **Category:** design +- **Parent:** core/buttons - **Supports:** anchor, color (background, gradients, text), shadow, spacing (padding), typography (fontSize, lineHeight), ~~alignWide~~, ~~align~~, ~~reusable~~ - **Attributes:** backgroundColor, gradient, linkTarget, placeholder, rel, text, textAlign, textColor, title, url, width @@ -95,6 +97,7 @@ A single column within a columns block. ([Source](https://github.com/WordPress/g - **Name:** core/column - **Category:** design +- **Parent:** core/columns - **Supports:** anchor, color (background, gradients, link, text), spacing (blockGap, padding), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** allowedBlocks, templateLock, verticalAlignment, width @@ -112,6 +115,7 @@ Display content in multiple columns, with blocks added to each column. ([Source] This block is deprecated. Please use the Avatar block instead. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/comment-author-avatar)) - **Name:** core/comment-author-avatar +- **Experimental:** fse - **Category:** theme - **Supports:** anchor, color (background, ~~text~~), spacing (margin, padding), ~~html~~, ~~inserter~~ - **Attributes:** height, width @@ -167,6 +171,7 @@ Contains the block elements used to display a comment, like the title, date, aut - **Name:** core/comment-template - **Category:** design +- **Parent:** core/comments - **Supports:** align, anchor, spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** @@ -185,6 +190,7 @@ Displays a paginated navigation to next/previous set of comments, when applicabl - **Name:** core/comments-pagination - **Category:** theme +- **Parent:** core/comments - **Supports:** align, anchor, color (background, gradients, link, text), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** paginationArrow @@ -194,6 +200,7 @@ Displays the next comment's page link. ([Source](https://github.com/WordPress/gu - **Name:** core/comments-pagination-next - **Category:** theme +- **Parent:** core/comments-pagination - **Supports:** anchor, color (background, gradients, ~~text~~), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** label @@ -203,6 +210,7 @@ Displays a list of page numbers for comments pagination. ([Source](https://githu - **Name:** core/comments-pagination-numbers - **Category:** theme +- **Parent:** core/comments-pagination - **Supports:** anchor, color (background, gradients, ~~text~~), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** @@ -212,6 +220,7 @@ Displays the previous comment's page link. ([Source](https://github.com/WordPres - **Name:** core/comments-pagination-previous - **Category:** theme +- **Parent:** core/comments-pagination - **Supports:** anchor, color (background, gradients, ~~text~~), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** label @@ -238,6 +247,7 @@ Add an image or video with a text overlay. ([Source](https://github.com/WordPres Hide and show additional content. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/details)) - **Name:** core/details +- **Experimental:** true - **Category:** text - **Supports:** align (full, wide), color (background, gradients, link, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~ - **Attributes:** showContent, summary @@ -302,6 +312,7 @@ Create a link that always points to the homepage of the site. Usually not necess - **Name:** core/home-link - **Category:** design +- **Parent:** core/navigation - **Supports:** anchor, typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** label @@ -356,6 +367,7 @@ Create a list item. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/ - **Name:** core/list-item - **Category:** text +- **Parent:** core/list - **Supports:** typography (fontSize, lineHeight), ~~className~~ - **Attributes:** content, placeholder @@ -410,6 +422,7 @@ Add a page, link, or another item to your navigation. ([Source](https://github.c - **Name:** core/navigation-link - **Category:** design +- **Parent:** core/navigation - **Supports:** typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** description, id, isTopLevelLink, kind, label, opensInNewTab, rel, title, type, url @@ -419,6 +432,7 @@ Add a submenu to your navigation. ([Source](https://github.com/WordPress/gutenbe - **Name:** core/navigation-submenu - **Category:** design +- **Parent:** core/navigation - **Supports:** ~~html~~, ~~reusable~~ - **Attributes:** description, id, isTopLevelItem, kind, label, opensInNewTab, rel, title, type, url @@ -428,6 +442,7 @@ Separate your content into a multi-page experience. ([Source](https://github.com - **Name:** core/nextpage - **Category:** design +- **Parent:** core/post-content - **Supports:** ~~className~~, ~~customClassName~~, ~~html~~ - **Attributes:** @@ -446,6 +461,7 @@ Displays a page inside a list of all pages. ([Source](https://github.com/WordPre - **Name:** core/page-list-item - **Category:** widgets +- **Parent:** core/page-list - **Supports:** ~~html~~, ~~inserter~~, ~~lock~~, ~~reusable~~ - **Attributes:** hasChildren, id, label, link, title @@ -499,6 +515,7 @@ The author name. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/pac This block is deprecated. Please use the Comments block instead. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/post-comment)) - **Name:** core/post-comment +- **Experimental:** fse - **Category:** theme - **Supports:** ~~html~~, ~~inserter~~ - **Attributes:** commentId @@ -508,6 +525,7 @@ This block is deprecated. Please use the Comments block instead. ([Source](https Display a post's comments count. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/post-comments-count)) - **Name:** core/post-comments-count +- **Experimental:** fse - **Category:** theme - **Supports:** anchor, color (background, gradients, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~ - **Attributes:** textAlign @@ -526,6 +544,7 @@ Display a post's comments form. ([Source](https://github.com/WordPress/gutenberg Displays the link to the current post comments. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/post-comments-link)) - **Name:** core/post-comments-link +- **Experimental:** fse - **Category:** theme - **Supports:** anchor, color (background, link, ~~text~~), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~ - **Attributes:** textAlign @@ -581,6 +600,7 @@ Contains the block elements used to render a post, like the title, date, feature - **Name:** core/post-template - **Category:** theme +- **Parent:** core/query - **Supports:** align (full, wide), anchor, color (background, gradients, link, text), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** @@ -598,6 +618,7 @@ Post terms. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages Show minutes required to finish reading the post. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/post-time-to-read)) - **Name:** core/post-time-to-read +- **Experimental:** true - **Category:** theme - **Supports:** color (background, gradients, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~ - **Attributes:** textAlign @@ -644,6 +665,7 @@ Contains the block elements used to render content when no query results are fou - **Name:** core/query-no-results - **Category:** theme +- **Parent:** core/query - **Supports:** align, anchor, color (background, gradients, link, text), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** @@ -653,6 +675,7 @@ Displays a paginated navigation to next/previous set of posts, when applicable. - **Name:** core/query-pagination - **Category:** theme +- **Parent:** core/query - **Supports:** align, anchor, color (background, gradients, link, text), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** paginationArrow @@ -662,6 +685,7 @@ Displays the next posts page link. ([Source](https://github.com/WordPress/gutenb - **Name:** core/query-pagination-next - **Category:** theme +- **Parent:** core/query-pagination - **Supports:** anchor, color (background, gradients, ~~text~~), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** label @@ -671,6 +695,7 @@ Displays a list of page numbers for pagination ([Source](https://github.com/Word - **Name:** core/query-pagination-numbers - **Category:** theme +- **Parent:** core/query-pagination - **Supports:** anchor, color (background, gradients, ~~text~~), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** @@ -680,6 +705,7 @@ Displays the previous posts page link. ([Source](https://github.com/WordPress/gu - **Name:** core/query-pagination-previous - **Category:** theme +- **Parent:** core/query-pagination - **Supports:** anchor, color (background, gradients, ~~text~~), typography (fontSize, lineHeight), ~~html~~, ~~reusable~~ - **Attributes:** label @@ -779,6 +805,7 @@ Display an icon linking to a social media profile or site. ([Source](https://git - **Name:** core/social-link - **Category:** widgets +- **Parent:** core/social-links - **Supports:** anchor, ~~html~~, ~~reusable~~ - **Attributes:** label, rel, service, url @@ -814,6 +841,7 @@ Create structured content in rows and columns to display information. ([Source]( Summarize your post with a list of headings. Add HTML anchors to Heading blocks to link them here. ([Source](https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/table-of-contents)) - **Name:** core/table-of-contents +- **Experimental:** true - **Category:** layout - **Supports:** color (background, gradients, link, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~ - **Attributes:** headings, onlyIncludeCurrentPage