Adding deprecated warning icon/message in graphQL docs #2749
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
|
Nice work 🎉 Is it possible to use the exclamation triangle instead of a circle to better signify more of a warning to the end user? |
|
There's a https://storybook.insomnia.rest/?path=/story/iconography-core-icons--reference |
Comment on lines
81
to
82
| const deprecatedFieldDescription = field => | ||
| `The field ${field.name} is deprecated. ${field.deprecationReason}`; |
There was a problem hiding this comment.
- Please could you move the creation of this function out of the render flow, so that the function is not recreated on every render?
- Please add speech marks around the field name (like
The field "currentUser" is deprecated...) to make it a little clearer.
There was a problem hiding this comment.
Hey guys. Thank you for the feedback :D
- I replaced the circle warning icon with the one from insomnia-components.
- The deprecationDescription function was moved out from the render function.
- Quote marks were added around the deprecated field name.
There was a problem hiding this comment.
Nice one. Do you know why the spacing looks a little off with the icon? I wonder if there is a rogue style being applied, adding padding/margin or something 🤔
8614316
to
73876ad
Compare
DMarby
reviewed
Oct 23, 2020
packages/insomnia-app/app/ui/components/graph-ql-explorer/graph-ql-explorer-type.js
Outdated
Show resolved
Hide resolved
DMarby
approved these changes
Oct 26, 2020
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 is adding a warning icon to every deprecated field shown in the GraphQL schema explorer, also the deprecating reason is being shown in the icon tooltip. It closes #1831
