From 59e96c440c9707f77679dd6562eb591df86073fa Mon Sep 17 00:00:00 2001 From: rishishah-multidots Date: Thu, 22 Aug 2024 19:33:27 +0530 Subject: [PATCH] remove readme.md file from collab folder --- .../src/components/collab/README.md | 50 ------------------- 1 file changed, 50 deletions(-) delete mode 100644 packages/block-editor/src/components/collab/README.md diff --git a/packages/block-editor/src/components/collab/README.md b/packages/block-editor/src/components/collab/README.md deleted file mode 100644 index c51da803c77ae..0000000000000 --- a/packages/block-editor/src/components/collab/README.md +++ /dev/null @@ -1,50 +0,0 @@ -## Alignment Control - -The `AlignmentControl` component renders a dropdown menu that displays alignment options for the selected block. - -This component is mostly used for blocks that display text, such as Heading, Paragraph, Post Author, Post Comments, Verse, Quote, Post Title, etc... And the available alignment options are `left`, `center` or `right` alignment. - -![Post Title block alignment options](https://make.wordpress.org/core/files/2020/09/post-title-block-alignment-options.png) - -## Development guidelines - -### Usage - -Renders an alignment toolbar with alignments options. - -```jsx -import { AlignmentControl } from '@wordpress/block-editor'; - -const MyAlignmentToolbar = () => ( - - { - setAttributes( { textAlign: nextAlign } ); - } } - /> - -); -``` - -_Note:_ In this example that we render `AlignmentControl` as a child of the `BlockControls` component. - -### Props - -### `value` - -- **Type:** `String` -- **Default:** `undefined` -- **Options:** `left`, `center`, `right` - -The current value of the alignment setting. You may only choose from the `Options` listed above. - -### `onChange` - -- **Type:** `Function` - -A callback function invoked when the toolbar's alignment value is changed via an interaction with any of the toolbar's buttons. Called with the new alignment value (ie: `left`, `center`, `right`, `undefined`) as the only argument. - -## 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/HEAD/packages/block-editor/src/components/provider/README.md) in the components tree.