Add better explanation on when to use PanelRow #60515
Open
Conversation
This file contains hidden or 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
|
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. |
Member
|
Looks good to me although would appreciate someone with more knowledge to approve this. |
tyxla
reviewed
Nov 19, 2024
|
|
||
| The `Panel` creates a container with a header that can take collapsible `PanelBody` components to easily create a user friendly interface for affecting state and attributes. | ||
|
|
||
| A `PanelRow` is only necessary when you want to wrap multiple components in a row. With only one component, there is no difference in wrapping it in a `PanelRow` or not. |
Member
There was a problem hiding this comment.
Does it make sense to put this where the rest of the PanelRow documentation is (a few paragraphs down, basically)?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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?
Adds better explanation on when to use a
PanelRowcomponent and when not.Why?
In #41671 it was mentioned (comment), that using a PanelRow for single components is not necessary / may have side-effects. For example some inputs may not render as expected, since they are flex-children. For my self, the documentation suggested, that the structure should always be
Panel>PanelBody>PanelRow. I think it may make sense, to explicitly state, that using a PanelRow is not necessary.Here's a screenshot showing the difference:
PanelRow is a flex-child and adds margin-top.
Open Questions
The markdown file in question has some linting errors: missing image alt texts and especially duplicate heading ids. Is there a rule on how to avoid duplicate heading ids if the headings are the same (
Usage)?How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast