-
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.
- Loading branch information
Showing
1 changed file
with
55 additions
and
0 deletions.
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
packages/block-editor/src/components/block-styles/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,55 @@ | ||
|
||
# Block Styles | ||
|
||
This `BlockStyles` component displays available block styles in the Settings Sidebar, allowing users to preview and switch between them. | ||
|
||
|
||
## Table of contents | ||
|
||
1. [Development guidelines](#development-guidelines) | ||
2. [Related components](#related-components) | ||
|
||
|
||
## Development guidelines | ||
|
||
### Usage | ||
```jsx | ||
import { BlockStyles } from '@wordpress/block-editor'; | ||
|
||
const MyBlockStyles = () => ( | ||
<BlockStyles | ||
clientId="block_123" | ||
onSwitch={ ( styleName ) => { | ||
// Handle style switch | ||
} } | ||
onHoverClassName={ ( styleName ) => { | ||
// Handle hover class name | ||
} } | ||
/> | ||
); | ||
``` | ||
|
||
### Props | ||
|
||
### `clientId` | ||
|
||
**Type**: `string` | ||
|
||
The block client ID. | ||
|
||
### `onSwitch` | ||
|
||
**Type**: `Function` | ||
**Default**: noop | ||
|
||
A function that is called when a block style is selected. | ||
|
||
### `onHoverClassName` | ||
|
||
**Type**: `Function` | ||
**Default**: noop | ||
|
||
A function that is called when a block style is hovered. | ||
|
||
## 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. |