@wordpress/block-editor
Version:
51 lines (32 loc) • 1.78 kB
Markdown
## 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.

## Development guidelines
### Usage
Renders an alignment toolbar with alignments options.
```jsx
import { AlignmentControl } from '@wordpress/block-editor';
const MyAlignmentToolbar = () => (
<BlockControls group="block">
<AlignmentControl
value={ textAlign }
onChange={ ( nextAlign ) => {
setAttributes( { textAlign: nextAlign } );
} }
/>
</BlockControls>
);
```
_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.