Skip to content

Commit

Permalink
Auto-generate PostVisibility component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
colorful-tones committed May 17, 2024
1 parent 097537e commit ade7184
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions packages/editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1154,13 +1154,11 @@ Undocumented declaration.

### PostVisibility

PostVisibility component.

Allows users to set the visibility of a post.

_Parameters_

- _props_ `Object`: Component properties.
- _props_ `Object`: The component props.
- _props.onClose_ `Function`: Function to call when the popover is closed.

_Returns_
Expand All @@ -1169,23 +1167,19 @@ _Returns_

### PostVisibilityCheck

PostVisibilityCheck component.

Determines if the current post can be edited (published) and passes this information to the provided render function.

_Parameters_

- _props_ `Object`: - Component properties.
- _props.render_ `Function`: - Function to render the component. Receives an object with a `canEdit` property.
- _props_ `Object`: The component props.
- _props.render_ `Function`: Function to render the component. Receives an object with a `canEdit` property.

_Returns_

- `JSX.Element`: Rendered component.
- `JSX.Element`: The rendered component.

### PostVisibilityLabel

PostVisibilityLabel component.

Returns the label for the current post visibility setting.

_Returns_
Expand Down

0 comments on commit ade7184

Please sign in to comment.