[EuiText docs] Add callout with usage instructions #5946
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
miukimiu
added
documentation
…sage-instructions
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5946/ |
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5946/ |
cee-chen
approved these changes
Jun 6, 2022
…sage-instructions
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5946/ |
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.
Summary
This PR is a follow-up on #5895 (comment) (emphasize that consumers shouldn't wrap the elements in a div).
So I basically added a callout with some usage instructions:
I also fixed the
divwrapping issue in our docs. So I searched for:And replaced all the
divs with fragments or just removed thedivin cases the elements didn't required being wrapped. These are the pages affected:Checklist
[ ] Checked in both light and dark modes[ ] Checked in mobile[ ] Props have proper autodocs and playground toggles[ ] Checked Code Sandbox works for any docs examples[ ] Added or updated jest and cypress tests[ ] Checked for breaking changes and labeled appropriately[ ] Checked for accessibility including keyboard-only and screenreader modes[ ] Updated the Figma library counterpart[ ] A changelog entry exists and is marked appropriately