From a4e381b0346b59b101a09eabdab1cfb87726db54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Justin=20S=C3=A8gb=C3=A9dji=20Ahinon?= Date: Mon, 31 Aug 2020 09:25:39 +0100 Subject: [PATCH] Add BlockMover component readme (#24851) --- .../src/components/block-mover/README.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 packages/block-editor/src/components/block-mover/README.md diff --git a/packages/block-editor/src/components/block-mover/README.md b/packages/block-editor/src/components/block-mover/README.md new file mode 100644 index 00000000000000..1240c42bc6ed8f --- /dev/null +++ b/packages/block-editor/src/components/block-mover/README.md @@ -0,0 +1,35 @@ +# Block mover + +Block movers allow moving blocks inside the editor using up and down buttons. + +![Block mover screenshot](https://make.wordpress.org/core/files/2020/08/block-mover-screenshot.png) + + +## Table of contents + +1. [Development guidelines](#development-guidelines) +2. [Related components](#related-components) + + +## Development guidelines + +### Usage + +Shows the block mover buttons in the block toolbar. + +```jsx +import { BlockMover } from '@wordpress/block-editor'; +const MyMover = () => ; +``` + +### Props + +#### clientIds + +Blocks IDs + +- Type: `Array` + + +## 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. \ No newline at end of file