⚽ Live Match: WordPress/gutenberg/pull/

dhruvikpatel18 · 2025-03-04T11:08:24Z

What?

Part of: #22891

Why?

This PR adds the README for Block Actions component

Testing Instructions

none

Screenshots or screencast

none

github-actions · 2025-03-04T11:45:45Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: dhruvikpatel18 <dhruvik18@git.wordpress.org>
Co-authored-by: im3dabasia <im3dabasia1@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

im3dabasia

@dhruvikpatel18 , Thanks for picking this up!

Left a few feedbacks. Please address them. If you have any doubts please ping me.

The Dependencies, Features, and trailing "For more details…" sections don't appear in other READMEs Could those go?

im3dabasia · 2026-08-11T11:13:43Z

+| ------------------------------- | ---------- | -------------------------------------------------------------------- |
+| `clientIds`                     | `string[]` | Array of block client IDs to perform actions on.                     |
+| `children`                      | `function` | A render prop function that receives available actions as an object. |
+| `__experimentalUpdateSelection` | `function` | (Experimental) Function to update block selection after an action.   |


__experimentalUpdateSelection is documented as a function, but it's a boolean, it's passed straight through as the 2nd arg to duplicateBlocks( clientIds, updateSelection = true ).

Would boolean, default true, be more accurate?

im3dabasia · 2026-08-11T11:23:37Z

+### Provided Actions
+
+The `children` function receives an object with the following properties, which can be used to trigger block actions:
+
+| Action           | Type                  | Description                                            |
+| ---------------- | --------------------- | ------------------------------------------------------ |
+| `onDuplicate`    | `() => void`          | Duplicates the selected blocks.                        |
+| `onRemove`       | `() => void`          | Removes the selected blocks.                           |
+| `onInsertBefore` | `() => void`          | Inserts a new block before the selected blocks.        |
+| `onInsertAfter`  | `() => void`          | Inserts a new block after the selected blocks.         |
+| `onGroup`        | `() => void`          | Groups the selected blocks into a container block.     |
+| `onUngroup`      | `() => void`          | Ungroups a grouped block, extracting its inner blocks. |
+| `onCopy`         | `() => void`          | Copies the selected block(s) for later pasting.        |
+| `onPasteStyles`  | `() => Promise<void>` | Pastes styles from copied blocks.                      |


One more thought on structure, the render prop values are currently in their own "Provided Actions" section.

Could they live under children in ###Props instead? That's what Dropdown does for its renderContent callback args, and it keeps everything the consumer touches in one place.

Only hesitation is that Dropdown has 3 args and this has 12, so nested bullets might get hard to scan, your call on which reads better.

Either way though, "Provided Actions" isn't quite right for the four can* flags.

im3dabasia · 2026-08-11T11:26:05Z

+| `onInsertAfter`  | `() => void`          | Inserts a new block after the selected blocks.         |
+| `onGroup`        | `() => void`          | Groups the selected blocks into a container block.     |
+| `onUngroup`      | `() => void`          | Ungroups a grouped block, extracting its inner blocks. |
+| `onCopy`         | `() => void`          | Copies the selected block(s) for later pasting.        |


onCopy doesn't actually copy, it only flashes the block; the clipboard write lives in the consumer. Worth rewording?

im3dabasia · 2026-08-11T11:26:32Z

@@ -0,0 +1,71 @@
+## Block Actions


The heading is ##; nearly all component READMEs here start with # (markdownlint flags it as MD041 too).

im3dabasia · 2026-08-11T11:30:28Z

+### Props
+
+| Prop                            | Type       | Description                                                          |
+| ------------------------------- | ---------- | -------------------------------------------------------------------- |


Follow the block-editor README format.

Siblings use
## Development guidelines → ### Usage → ### Props → #### propName with - **Type:**, not a markdown table, see dimension-control/README.md and height-control/README.md.

im3dabasia · 2026-08-11T11:34:01Z

+### Usage
+
+```jsx
+import BlockActions from './block-actions';


The usage example's import BlockActions from './block-actions' won't work for a reader, the component isn't exported from @wordpress/block-editor at all. Its only consumer imports it relatively. Worth a note that it's component-internal?

im3dabasia · 2026-08-11T11:35:53Z

+| `onDuplicate`    | `() => void`          | Duplicates the selected blocks.                        |
+| `onRemove`       | `() => void`          | Removes the selected blocks.                           |


onDuplicate / onRemove are typed () => void but both return the dispatch result. Minor, but onPasteStyles got it right so the inconsistency stands out.

im3dabasia · 2026-08-11T11:41:55Z

+---
+
+For more details, refer to the [WordPress Gutenberg repository](https://github.com/WordPress/gutenberg).
+


Many of these READMEs close with the standard "Block Editor components … can only be used under a BlockEditorProvider" footer. Might be worth adding for consistency.

Here is the clause

Block Editor components are components that can be used to compose the UI of your block editor. Thus, they can only be used under a [BlockEditorProvider](https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/provider/README.md) in the components tree.

im3dabasia · 2026-08-11T11:43:24Z

+### Related Components
+
+- `usePasteStyles` – Used to handle copying and pasting block styles.
+- `block-editor/store` – The primary store for managing block actions.


We can probably remove this. Doesn't add value imo. What do you think?

Related Components lists usePasteStyles (a hook, and it only pastes, it doesn't copy) and block-editor/store (a store, not a component).

im3dabasia · 2026-08-11T11:43:58Z

+---
+
+For more details, refer to the [WordPress Gutenberg repository](https://github.com/WordPress/gutenberg).


The trailing --- + "For more details, refer to the WordPress Gutenberg repository" isn't present in any other README and reads as filler.

I think we can do away with this?

… props details

im3dabasia

LGTM ✅

Thanks for working on this!

* Docs: Add Block Actions Readme * Docs: Update README for BlockActions component with clearer usage and props details Co-authored-by: dhruvikpatel18 <dhruvik18@git.wordpress.org> Co-authored-by: im3dabasia <im3dabasia1@git.wordpress.org>

Docs: Add Block Actions Readme

5fd6522

dhruvikpatel18 marked this pull request as ready for review March 4, 2025 11:45

dhruvikpatel18 requested a review from ellatrix as a code owner March 4, 2025 11:45

Mamaduka added the [Type] Developer Documentation Documentation for developers label Mar 5, 2025

Merge branch 'trunk' into add/block-actions-readme

9387804

github-actions Bot added the [Package] Block editor /packages/block-editor label Aug 11, 2026

im3dabasia requested changes Aug 11, 2026

View reviewed changes

Docs: Update README for BlockActions component with clearer usage and…

fcd09a6

… props details

dhruvikpatel18 requested a review from im3dabasia August 11, 2026 12:43

im3dabasia approved these changes Aug 12, 2026

View reviewed changes

im3dabasia merged commit ac8de62 into WordPress:trunk Aug 12, 2026
43 checks passed

github-actions Bot added this to the Gutenberg 23.8 milestone Aug 12, 2026

dhruvikpatel18 mentioned this pull request Aug 12, 2026

BlockActions: Update Developer Documentation #68985

Closed

This was referenced Aug 13, 2026

docs: Add README for BlockActions component #78446

Closed

Create README for "block-actions" component #52046

Closed

		\| `onDuplicate` \| `() => void` \| Duplicates the selected blocks. \|
		\| `onRemove` \| `() => void` \| Removes the selected blocks. \|

		---

		For more details, refer to the [WordPress Gutenberg repository](https://github.com/WordPress/gutenberg).

Uh oh!

Conversation

dhruvikpatel18 commented Mar 4, 2025

What?

Why?

Testing Instructions

Screenshots or screencast

Uh oh!

github-actions Bot commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

im3dabasia left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

im3dabasia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Mar 4, 2025 •

edited

Loading