Add MenuGroup design documentation #14466
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
Add design guidelines and screenshots.
kjellr
added
[Type] Developer Documentation
kjellr
requested review from
aduth,
ajitbohra,
chrisvanpatten,
gziolo,
jorgefilipecosta,
noisysocks,
talldan and
youknowriad
as code owners
kjellr
changed the title
karmatosed
approved these changes
Mar 15, 2019
davewhitley
approved these changes
Mar 15, 2019
|
|
||
| ### Usage | ||
|
|
||
| A `MenuGroup` should be used to indicate that two or more individual MenuItems are related. When other menu items exist above or below a `MenuGroup`, the group should have a divider line between it and the adjacent item. A MenuGroup can optionally include a label to describe its contents. |
There was a problem hiding this comment.
No tick marks around MenuGroup for some reason
Suggested change
| A `MenuGroup` should be used to indicate that two or more individual MenuItems are related. When other menu items exist above or below a `MenuGroup`, the group should have a divider line between it and the adjacent item. A MenuGroup can optionally include a label to describe its contents. | |
| A `MenuGroup` should be used to indicate that two or more individual MenuItems are related. When other menu items exist above or below a `MenuGroup`, the group should have a divider line between it and the adjacent item. A `MenuGroup` can optionally include a label to describe its contents. |
Should "MenuItems" have tick marks?
There was a problem hiding this comment.
Yep, it should. Good catch! I've opened #14490 as a quick fix for that. 🙂
|
|
||
|  | ||
|
|
||
| 1. MenuGroup label |
There was a problem hiding this comment.
"MenuGroup" may be redundant, but it is a bit more clear since you mention other components above. I'll leave that up to you.
There was a problem hiding this comment.
Yeah, I think it's fine to repeat that there, for clarity's sake. Those should have tick marks like the other mentions of the components though. 👍
This was referenced Mar 20, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 20, 2019
* Update MenuGroup Readme. Add design guidelines and screenshots. * Adjust introduction to be more concise.
youknowriad
pushed a commit
that referenced
this pull request
Mar 20, 2019
* Update MenuGroup Readme. Add design guidelines and screenshots. * Adjust introduction to be more concise.
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.
This PR adds design guideline documentation for the
MenuGroupcomponent, in addition to the development documentation that existed previously. These guidelines are 'best practices' for the usage of the component, as well as describing the component in more detail.The new README can be previewed here:
https://github.com/WordPress/gutenberg/blob/a264af53c440a025d697da11b6c1de84136cdb48/packages/components/src/menu-group/README.md