feat(website): support HTML custom display of table entries #3576
Conversation
chaoran-chen
requested review from
fhennig,
theosanderson,
corneliusroemer and
anna-parker
There was a problem hiding this comment.
happy with this. I think if we decide to actually support tables we should actually implement a table feature directly - and I'd be uncertain as to whether Loculus should document the idea of using a custom element for this, but in terms of having the raw feature - sounds fair!
chaoran-chen
force-pushed
the
html-custom-display
branch
from
8a09e0d to
17c4fca
Compare
|
Thanks for reviewing, @theosanderson! (As it's not urgent, I'll keep the PR open for another day to see whether someone else has comments.) |
|
In the files it seems like the config option is still called I see how this is useful for this JSON thing! Can you maybe come up with more examples? I think having more could be nice to document this feature better. |
|
@fhennig, I think it's fine to keep the value just This can be used for all kinds of things: to embed an image, a video, map, plot, tree – whatever you can imagine! |
| additionalHeadHTML: '<script defer data-domain="loculus.org" src="https://plausible.io/js/script.js"></script>' | ||
| additionalHeadHTML: '<script defer data-domain="loculus.org" src="https://plausible.io/js/script.js"></script><script src="https://chaoran-chen.github.io/test-custom-display/frequency-custom-display.js"></script>' |
There was a problem hiding this comment.
Revert before merge
| customDisplay: | ||
| type: htmlTemplate | ||
| html: "<frequency-custom-display>__value__</frequency-custom-display>" |
There was a problem hiding this comment.
Revert before merge
preview URL: https://html-custom-display.loculus.org
Summary
This adds a new type of custom display "html" that allows the maintainer to provide an HTML template to render a table entry.
Background: I'd like to use that to improve the display of the frequency JSONs here.
To demonstrate the feature, the feature was used to make the country bold in the below screenshot.
Screenshot
PR Checklist
[ ] All necessary documentation has been adapted.Documentation is missing for the custom display feature and I propose adding it separately (Document customDisplay config #3574).[ ] The implemented feature is covered by an appropriate test.We don't have any tests for the other custom displays and I hope it's ok that we don't have one in this PR.