Skip to content

Commit

Permalink
Add anchor support for dynamic blocks (#44771)
Browse files Browse the repository at this point in the history 
* Add anchor support

* Add anchor support

* Remove duplicate block support after merge conflict

* Use wp_should_skip_block_supports_serialization

---------

Co-authored-by: Carolina Nymark <[email protected]>
Co-authored-by: Carolina Nymark <[email protected]>
  • Loading branch information
@Soean @carolinan
3 people authored Feb 1, 2023
1 parent a510201 commit 3bb63e4
Show file tree
Hide file tree
Showing 57 changed files with 176 additions and 55 deletions.
2 changes: 1 addition & 1 deletion docs/reference-guides/block-api/block-supports.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ function render_block() {
- Type: `boolean`
- Default value: `false`

Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link. _Important: It doesn't work with dynamic blocks yet._
Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link.

```js
// Declare support for anchor links.
Expand Down
106 changes: 53 additions & 53 deletions docs/reference-guides/core-blocks.md
View file

Large diffs are not rendered by default.

67 changes: 67 additions & 0 deletions lib/block-supports/anchor.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?php
/**
* Anchor block support flag.
*
* @package gutenberg
*/

/**
* Registers the anchor block attribute for block types that support it.
*
* @param WP_Block_Type $block_type Block Type.
*/
function gutenberg_register_anchor_support( $block_type ) {
$has_anchor_support = _wp_array_get( $block_type->supports, array( 'anchor' ), true );
if ( ! $has_anchor_support ) {
return;
}

if ( ! $block_type->attributes ) {
$block_type->attributes = array();
}

if ( ! array_key_exists( 'anchor', $block_type->attributes ) ) {
$block_type->attributes['anchor'] = array(
'type' => 'string',
);
}
}

/**
* Add the anchor to the output.
*
* @param WP_Block_Type $block_type Block Type.
* @param array $block_attributes Block attributes.
*
* @return array Block anchor.
*/
function gutenberg_apply_anchor_support( $block_type, $block_attributes ) {
if ( ! $block_attributes ) {
return array();
}

if ( wp_should_skip_block_supports_serialization( $block_type, 'anchor' ) ) {
return array();
}

$has_anchor_support = _wp_array_get( $block_type->supports, array( 'anchor' ), true );
if ( ! $has_anchor_support ) {
return array();
}

$has_anchor = array_key_exists( 'anchor', $block_attributes );
if ( ! $has_anchor ) {
return array();
}

return array( 'id' => $block_attributes['anchor'] );
}

// Register the block support.
WP_Block_Supports::get_instance()->register(
'anchor',
array(
'register_attribute' => 'gutenberg_register_anchor_support',
'apply' => 'gutenberg_apply_anchor_support',
)
);
1 change: 1 addition & 0 deletions lib/load.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,5 @@ function gutenberg_is_experiment_enabled( $name ) {
require __DIR__ . '/block-supports/spacing.php';
require __DIR__ . '/block-supports/dimensions.php';
require __DIR__ . '/block-supports/duotone.php';
require __DIR__ . '/block-supports/anchor.php';
require __DIR__ . '/block-supports/shadow.php';
1 change: 1 addition & 0 deletions packages/block-library/src/archives/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
},
"supports": {
"align": true,
"anchor": true,
"html": false,
"spacing": {
"margin": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/avatar/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
},
"usesContext": [ "postType", "postId", "commentId" ],
"supports": {
"anchor": true,
"html": false,
"align": true,
"alignWide": false,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/calendar/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
},
"supports": {
"align": true,
"anchor": true,
"color": {
"link": true,
"__experimentalSkipSerialization": [ "text", "background" ],
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/categories/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"supports": {
"align": true,
"anchor": true,
"html": false,
"spacing": {
"margin": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-author-avatar/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
},
"usesContext": [ "commentId" ],
"supports": {
"anchor": true,
"html": false,
"inserter": false,
"__experimentalBorder": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-author-name/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
},
"usesContext": [ "commentId" ],
"supports": {
"anchor": true,
"html": false,
"spacing": {
"margin": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-content/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
}
},
"supports": {
"anchor": true,
"color": {
"gradients": true,
"link": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-date/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
},
"usesContext": [ "commentId" ],
"supports": {
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-edit-link/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
}
},
"supports": {
"anchor": true,
"html": false,
"color": {
"link": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-reply-link/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
}
},
"supports": {
"anchor": true,
"color": {
"gradients": true,
"link": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comment-template/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"usesContext": [ "postId" ],
"supports": {
"align": true,
"anchor": true,
"html": false,
"reusable": false,
"spacing": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comments-pagination-next/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"usesContext": [ "postId", "comments/paginationArrow" ],
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"color": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comments-pagination-numbers/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"textdomain": "default",
"usesContext": [ "postId" ],
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"color": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comments-pagination-previous/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"usesContext": [ "postId", "comments/paginationArrow" ],
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"color": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/comments-pagination/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"comments/paginationArrow": "paginationArrow"
},
"supports": {
"anchor": true,
"align": true,
"reusable": false,
"html": false,
Expand Down
3 changes: 2 additions & 1 deletion packages/block-library/src/comments/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
},
"supports": {
"align": [ "wide", "full" ],
"anchor": true,
"html": false,
"color": {
"gradients": true,
"link": true,
Expand All @@ -27,7 +29,6 @@
"link": true
}
},
"html": false,
"spacing": {
"margin": true,
"padding": true
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/home-link/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"style"
],
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"typography": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/latest-comments/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
},
"supports": {
"align": true,
"anchor": true,
"html": false,
"spacing": {
"margin": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/latest-posts/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
},
"supports": {
"align": true,
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/loginout/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
}
},
"supports": {
"anchor": true,
"className": true,
"typography": {
"fontSize": false
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/navigation/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@
},
"supports": {
"align": [ "wide", "full" ],
"anchor": true,
"html": false,
"inserter": true,
"typography": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/page-list/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"openSubmenusOnClick"
],
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"typography": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-author-biography/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
},
"usesContext": [ "postType", "postId" ],
"supports": {
"anchor": true,
"spacing": {
"margin": true,
"padding": true
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-author-name/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
},
"usesContext": [ "postType", "postId" ],
"supports": {
"anchor": true,
"html": false,
"spacing": {
"margin": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-author/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
},
"usesContext": [ "postType", "postId", "queryId" ],
"supports": {
"anchor": true,
"html": false,
"spacing": {
"margin": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-comments-count/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"usesContext": [ "postId" ],
"supports": {
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-comments-form/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
},
"usesContext": [ "postId", "postType" ],
"supports": {
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-comments-link/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
}
},
"supports": {
"anchor": true,
"html": false,
"color": {
"link": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-content/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"textdomain": "default",
"usesContext": [ "postId", "postType", "queryId" ],
"supports": {
"anchor": true,
"align": [ "wide", "full" ],
"html": false,
"__experimentalLayout": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-date/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
},
"usesContext": [ "postId", "postType", "queryId" ],
"supports": {
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-excerpt/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
},
"usesContext": [ "postId", "postType", "queryId" ],
"supports": {
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-featured-image/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
"usesContext": [ "postId", "postType", "queryId" ],
"supports": {
"align": [ "left", "right", "center", "wide", "full" ],
"anchor": true,
"color": {
"__experimentalDuotone": "img, .wp-block-post-featured-image__placeholder, .components-placeholder__illustration, .components-placeholder::before",
"text": false,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-navigation-link/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
}
},
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"color": {
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-template/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"reusable": false,
"html": false,
"align": true,
"anchor": true,
"__experimentalLayout": {
"allowEditing": false
},
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-terms/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
},
"usesContext": [ "postId", "postType" ],
"supports": {
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/post-title/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
},
"supports": {
"align": [ "wide", "full" ],
"anchor": true,
"html": false,
"color": {
"gradients": true,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/query-no-results/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"textdomain": "default",
"usesContext": [ "queryId", "query" ],
"supports": {
"anchor": true,
"align": true,
"reusable": false,
"html": false,
Expand Down
1 change: 1 addition & 0 deletions packages/block-library/src/query-pagination-next/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"usesContext": [ "queryId", "query", "paginationArrow" ],
"supports": {
"anchor": true,
"reusable": false,
"html": false,
"color": {
Expand Down
Loading

1 comment on commit 3bb63e4

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flaky tests detected in 3bb63e4.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4062102941
📝 Reported issues:

Please sign in to comment.