Documentation: PostPreviewButton editor component #62036
Merged
Conversation
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
colorful-tones
added
the
[Type] Developer Documentation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
82 tasks
ntsekouras
reviewed
May 28, 2024
| @@ -99,6 +99,18 @@ function writeInterstitialMessage( targetDocument ) { | |||
| targetDocument.close(); | |||
| } | |||
|
|
|||
| /** | |||
| * A button for post preview. It uses WordPress data selectors to get the necessary data for the preview, such as the post ID, the current post link, the preview link, and whether the post is saveable and viewable. When the button is clicked, it opens a new window or tab for the preview, writes the interstitial message to this window, and then navigates to the actual preview link. The button is disabled if the post is not saveable. | |||
There was a problem hiding this comment.
I think we should have a bit higher level description..
Suggested change
| * A button for post preview. It uses WordPress data selectors to get the necessary data for the preview, such as the post ID, the current post link, the preview link, and whether the post is saveable and viewable. When the button is clicked, it opens a new window or tab for the preview, writes the interstitial message to this window, and then navigates to the actual preview link. The button is disabled if the post is not saveable. | |
| * Renders a button that opens a new window or tab for the preview, writes the interstitial message to this window, and then navigates to the actual preview link. The button is not rendered if the post is not viewable and disabled if the post is not saveable. |
There was a problem hiding this comment.
Also just noticed this.. We should probably wrap this comment in more lines to be consistent with our code base. I thought we had a linting rule for the max length of comments line, but it seems we don't 😄
ntsekouras
approved these changes
May 29, 2024
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jun 4, 2024
* Add JSDocs for PostPreviewButton editor component * Auto-generate editor docs for PostPreviewButton component add * Refine PostPreviewButton editor component JSDocs * Auto-generate editor docs for PostPreviewButton updates
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
* Add JSDocs for PostPreviewButton editor component * Auto-generate editor docs for PostPreviewButton component add * Refine PostPreviewButton editor component JSDocs * Auto-generate editor docs for PostPreviewButton updates
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What? & Why?
Addresses one item in #60358
Adding documentation to existing editor components can help with any of the following:
How?
Add a JSDoc comment to the
PostPreviewButtoncomponent and runnpm run docs:buildto populate theREADMEwith the newly added documents.