Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add Block Styles Readme #69399

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Docs: Add Block Styles Readme #69399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions packages/block-editor/src/components/block-styles/README.md
View file
Open in desktop
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.
Loading