Skip to content

Commit

Permalink
Add readme for UngroupButton (#25142)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinyAhin authored Sep 9, 2020
1 parent 0397f87 commit a2e828e
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions packages/block-editor/src/components/ungroup-button/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Ungroup Button

The `UngroupButton` components adds an icon on the BlockControls toolbar when a group block is selected. Then, it's possible to ungroup the inner blocks. After click on the icon, it removes the group block holding the InnerBlocks components which are moved one level up in the hierarchy.

This only happens in the mobile WordPress apps.

![Ungroup button icon](https://user-images.githubusercontent.com/21242757/65593577-11006000-df91-11e9-8460-1179e9ef46d2.png)


## Table of contents

1. [Development guidelines](#development-guidelines)
2. [Related components](#related-components)


## Development guidelines

### Usage

Display the `UngroupButton` icon.

```jsx
import { UngroupButton } from '@wordpress/block-editor';

const MyUngroupButton = () => <UngroupButton />;
```

## Related components

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/master/packages/block-editor/src/components/provider/README.md) in the components tree.

0 comments on commit a2e828e

Please sign in to comment.