ToolsPanel: Add a readme section related to laying out a ToolsPanel #42615
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
aaronrobertshaw
added
[Type] Developer Documentation
tellthemachines
approved these changes
Jul 22, 2022
This also includes updating the usage example to better illustrate layout.
aaronrobertshaw
force-pushed
the
update/tools-panel-readme-with-layout-example
branch
from
ce60fde
to
e726b47
Compare
aaronrobertshaw
deleted the
update/tools-panel-readme-with-layout-example
branch
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.
Related: #42309 (comment)
What?
Adds information relating to laying out elements or controls within a
ToolsPanelto the component's readme.Why?
While the
ToolsPanelis laid out via aGridcomponent internally, it does not yet expose grid props for full control (History: #35621). As such, it's not obvious from the docs how to achieve certain panel layouts.How?
ToolsPanelIteme.g. a panel descriptionNote: A storybook example illustrating varied layouts might also be a further step if required. This would likely be best in a follow-up after the
ToolsPanelstories have been updated to use the latest approach from the components package, including using Controls in place of Knobs.Testing Instructions