This article contains the Gtmhub best practices for writing insight HTML and CSS.
Ordering of Elements
A style tag, if present, should be at the start of the insight
Next should be the displayed HTML for the insight
Next should be any repeatable HTML template blocks used in Angular
Only one style tag per insight should be used
All styles should be prefixed with the ID of the wrapper div of the insight to prevent unintentional effects on other insights or other UI elements
Unless the specific intent is to affect something outside the insight
If you are doing this, add a comment to your CSS specifically indicating what you intend to change
This is especially true when targeting elements by HTML tag or if your class names have risk of collision with Gtmhub classes or classes in other insights.
All displayed HTML should be wrapped in a single div with a unique ID for the insight
Watch out when cloning an insight - make sure to update this ID
Avoid repeated use of inline styles on individual elements
Use a class or CSS instead
This de-clutters the HTML and makes it easier to make bulk changes in the future
If your style only needs to apply to one element, using an inline style is fine
✔️Or Do This
Avoid generic class names that may result in unintentional inheritance of styles from Gtmhub - including styles that don’t exist today but may be added in the future
If you specifically want to inherit the properties of existing classes, then using them is OK. Be aware they may change without warning
To help guarantee uniqueness of your class, pre-pend the insight div ID
No Data or One Row of Data
Make sure to handle the “No Data” case in the event that data is not returned by the SQL
For cases where multiple rows of data are generally expected, verify that a single row of data returned is handled properly.