Skip to content

Commit

Permalink
Add block inspector component readme (#24929)
Browse files Browse the repository at this point in the history
* Add block inspector component readme

* Update block inspector component readme
  • Loading branch information
JustinyAhin authored Aug 31, 2020
1 parent fb20b4f commit 0de26c5
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions packages/block-editor/src/components/block-inspector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Block Inspector

The Block inspector is one of the panels that is displayed in the editor; it is mainly used to view and modify the settings of the selected block.

![Paragraph block inspector](https://make.wordpress.org/core/files/2020/08/paragraph-block-inspector.png)

## Table of contents

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

### Usage

Render the block inspector component.

```jsx
import { BlockInspector } from '@wordpress/components';

const MyBlockInspector = () => <BlockInspector />
```
## 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 0de26c5

Please sign in to comment.