Skip to content

Commit

Permalink
Add/block icon component readme (#24947)
Browse files Browse the repository at this point in the history
* Draft block icon component readme

* Update block icon component readme

* Update block icon component readme

* Update BlockIcon component code sample

* Update BlockIcon component code sample

* Update JSX code sample
  • Loading branch information
JustinyAhin authored Sep 9, 2020
1 parent 25e6ae3 commit 0397f87
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions packages/block-editor/src/components/block-icon/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Block Icon

The BlockIcon component provides an icon for blocks in different places in the editor: the toolbar of a selected block, the placeholders of certain blocks (gallery, image), the block insertion panel of the editor or the left sidebar.

The rendered an [Icon](https://github.com/WordPress/gutenberg/tree/master/packages/components/src/icon) component with default styles.

![Image block icons in various places](https://make.wordpress.org/core/files/2020/08/image-block-icons-in-various-places.png)

## Table of contents

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


## Development guidelines

### Usage

Renders a block icon with default style.

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

const MyBlockIcon = () => <BlockIcon icon={ icon } />
```

## 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 0397f87

Please sign in to comment.