feat(elements): show tags description if exist #2594
Conversation
✅ Deploy Preview for stoplight-elements ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for stoplight-elements-demo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| groupsByTagId[tagId] = { | ||
| title: serviceTagName || tagName, | ||
| title: serviceTag?.description || serviceTag?.name || tagName, |
There was a problem hiding this comment.
I don't think this makes sense as the description could be very long. In my case the description could even be multiple paragraphs which will never fit into the small space of the expandable title.
There was a problem hiding this comment.
How about this:
groupsByTagId[tagId] = {
title: (serviceTag?.['x-show-description'] ? serviceTag.description : '') || serviceTag?.name || tagName,
}or
groupsByTagId[tagId] = {
title: (serviceTag?.description?.length <= 40 ? serviceTag.description : '') || serviceTag?.name || tagName,
}There was a problem hiding this comment.
I don't think that is good either. I'd still need a place where the full description is shown and not just part of it.
There was a problem hiding this comment.
I assume the idea here is to use the description-property of the tag when it's available? The fallback would be the name of the tag? I think we could use the x-traitTag vendor extension to distinguish between tags used for grouping in the table of contents or to tag operations.
You would then only consider x-traitTag=false for the description in the above case, if not, fallback to the name of the tag.
I think this is how Redocly is doing it.
There was a problem hiding this comment.
I ended up using x-displayName to allow a different title in the navigation compared to the actual tag. It's the same one that is used by Redocly
Airkro
force-pushed
the
tags-description
branch
from
c9ced5f
to
f36ef5d
Compare
Elements Default PR Template
In general, make sure you have: (check the boxes to acknowledge you've followed this template)
CONTRIBUTING.mdOther Available PR Templates:
CONTRIBUTING.md