Component style extend & customization #27
Description
Component style extend & customization
Who will benefit from this feature?
The immediate benefactors would be the Salesforce Docs team who are utilizing the ARC components to render reference documentation in their web portal, and wish to have the reference styled in a specific way.
In the long term, future consumers may also utilize the CSS variables to style it their own way if they wish.
Overview
This is a feature request to expand the style customizations to api documentation and the sub components. My proposal is to introduce a few CSS parts and more CSS variables in a backwards compatible fashion.
List of sub-components that could see change:
- api-summary
- api-endpoint-documentation
- api-method-documentation
- api-type-documentation
- api-body-document
- api-resource-example-document
- api-type-document
- markdown-styles
Use cases
- Style individual section titles and headings
- Increased control over spacing
- Enhanced markdown style for arc-marked markdown content
Do you know anyone else, internal or external, that is also interested in this feature?
Salesforce Developer WebOps team would also like to see this feature since they are consuming SF Docs.
Do you expect this feature to be fairly stable? How might it be extended or changed in the future?
It is fairly stable and backwards compatible.
List every UI surface belonging to or potentially affected by this feature:
- Consumers of
api-documentation - Consumers of
markdown-styles
How could this feature be abused?
Mostly styling changes so I don't expect there to be security implications.
Imagine you’re Dr. Evil app user, list the three worst evil deeds you could commit with your feature (if you’ve got good ones, feel free to add more):
- If a security vulnerability surfaced for CSS parts, they could leverage that somehow on the new parts introduced.
- The evil person could inject a CSS style sheet that set the style in such a way that the content is hidden from the screen.
- The evil person could make the styling look really terrible.