Forum Discussion

mhedblom's avatar
mhedblom
New Member
24 days ago

How do I get Elements issues addressed?

I have a documentation web site generated by a third party who uses StopLight Elements to render my API pages.  I am using CSS to customize the page appearance to match our brand.  However, there are several places in the Elements page where CSS doesn't work either because there are hard-coded HTML style attributes, there is no class attribute, or the shadow DOM was not coded to pass styles.  Here are some examples:

  • TOC endpoints have hard-coded @style (width=”75%”) attributes instead of using @classes. When the labels wrap they are hard to read, and there is no way to control it. (Support ticket #16725.) 

  • Cannot change the styling of “code” listings.  The code elements rendered in a shadow DOM have hard-coded HTML @style attributes which cannot be overridden with CSS. This looks especially bad when using a dark-mode page which our developer audience prefers. There are ways to pass style values to the shadow DOM, but the implementation in Elements is not coded to accept them.

  • Significant HTML elements need unique @class identifiers. You can use combinations REACT class names and hope you only affect the change on the target element. This will break if the REACT class assignments ever change.

  •  Array (oneOf) Body Responses do not render in a way that is easy to notice: they are enumerated in a dropdown which is easy for a user to miss. When there are multiple (oneOf) Body Responses, button, tabs or an accordion would be better than the current popup/dropdown menu. 

What is the best way to get these Elements issues addressed?

If necessary I could try to "contribute" to the code, but the procedures documented are just a little above my comfort level.  But if that is the best way to get them addressed, I'll do it.

No RepliesBe the first to reply