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 Modify Content Lock Menu Items readme #69391

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

Docs: Add Modify Content Lock Menu Items readme #69391

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
39 changes: 39 additions & 0 deletions packages/block-editor/src/components/content-lock/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Content Lock

The `ContentLock` component is a component that can be used to lock the content of a block. It is used to prevent the user from interacting with the block's content, and is typically used when the block is in a read-only state.

## Table of contents

1. [Development guidelines](#development-guidelines)
2. [Related components](#related-components)

## Development guidelines

### Usage

```jsx
import { ModifyContentLockMenuItem } from '@wordpress/block-editor';

const MyBlock = () => {
return (
<ModifyContentLockMenuItem
clientId={ clientId }
onClose={ onClose }
></ModifyContentLockMenuItem>
);
};
```

### Props

### `clientId`

**Type**: `string`

### `onClose`

**Type**: `Function`

## 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