-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Add JSDoc to PostVisibility, PostVisibilityCheck, and PostVisibilityLabel #61735
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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 |
---|---|---|
|
@@ -17,6 +17,15 @@ import { __experimentalInspectorPopoverHeader as InspectorPopoverHeader } from ' | |
import { visibilityOptions } from './utils'; | ||
import { store as editorStore } from '../../store'; | ||
|
||
/** | ||
* PostVisibility component. | ||
* | ||
* Allows users to set the visibility of a post. | ||
* | ||
* @param {Object} props Component properties. | ||
* @param {Function} props.onClose Function to call when the popover is closed. | ||
* @return {JSX.Element} The rendered component. | ||
*/ | ||
export default function PostVisibility( { onClose } ) { | ||
const instanceId = useInstanceId( PostVisibility ); | ||
|
||
|
@@ -133,6 +142,18 @@ export default function PostVisibility( { onClose } ) { | |
); | ||
} | ||
|
||
/** | ||
* PostVisibilityChoice component. | ||
* | ||
* Renders a visibility choice option. | ||
* | ||
* @param {Object} props - Component properties. | ||
* @param {number} props.instanceId - Unique instance ID for the component. | ||
* @param {string} props.value - The value of the visibility option. | ||
* @param {string} props.label - The label for the visibility option. | ||
* @param {string} props.info - Additional information about the visibility option. | ||
* @return {JSX.Element} The rendered component. | ||
*/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not exported so we could leave it as is, though it doesn't hurt to have it 😄 . |
||
function PostVisibilityChoice( { instanceId, value, label, info, ...props } ) { | ||
return ( | ||
<div className="editor-post-visibility__choice"> | ||
|
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to remove this
PostVisibility component.
from every component because the generated docs include the component's name, so it's kind of duplicate..