-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Add README.md for text-alignment-control
- Loading branch information
1 parent
1b14b1e
commit 5525c9f
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
packages/block-editor/src/components/text-alignment-control/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# TextAlignmentControl | ||
|
||
The `TextAlignmentControl` component is responsible for rendering a control element that allows users to select and apply text alignment options to blocks or elements in the Gutenberg editor. It provides an intuitive interface for aligning text with options such as `left`, `center`, `right`, and `justify`. | ||
|
||
## Development guidelines | ||
|
||
### Usage | ||
|
||
Renders the Text Alignment Component with `left`, `center`, `right`, and `justify` alignment options. | ||
|
||
```jsx | ||
import { TextAlignmentControl } from '@wordpress/block-editor'; | ||
|
||
const MyTextAlignmentControlComponent = () => ( | ||
<TextAlignmentControl | ||
value={ textAlign } | ||
onChange={ ( value ) => { | ||
setAttributes( { textAlign: value } ); | ||
} } | ||
/> | ||
); | ||
``` | ||
|
||
### Props | ||
|
||
### `value` | ||
|
||
- **Type:** `String` | ||
- **Default:** `left` | ||
- **Options:** `left`, `center`, `right`, `justify` | ||
|
||
The current value of the text alignment setting. You may only choose from the `Options` listed above. | ||
|
||
### `onChange` | ||
|
||
- **Type:** `Function` | ||
|
||
A callback function invoked when the text alignment value is changed via an interaction with any of the options. The function is called with the new alignment value (`left`, `center`, `right`, `justify`) as the only argument. | ||
|
||
### `className` | ||
|
||
- **Type:** `String` | ||
|
||
Class name to add to the control for custom styling. | ||
|
||
### `options` | ||
|
||
- **Type:** `Array` | ||
- **Default:** [`left`, `center`, `right`] | ||
|
||
An array that determines which alignment options will be available in the control. You can pass an array of alignment values to customize the options. |