Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add block inspector component readme #24929

Merged
merged 2 commits into from
Aug 31, 2020
Merged

Add block inspector component readme #24929

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db5cdf9
Add block inspector component readme
JustinyAhin Aug 31, 2020
bb8538f
Update block inspector component readme
JustinyAhin Aug 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions packages/block-editor/src/components/block-inspector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Block Inspector

The Block inspector is one of the panels on the right sidebar of the editor; it is mainly used to view and modify the settings of the selected block.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if really need to mention "right sidebar" because it's a generic component that can be rendered anywhere. In the post editor, it happens to be rendered there.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah , makes sense. my initial description was how it is displayed in the editor.
Just edited.


![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.