DEV-16534: WebC Figure image refactor #885
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…figure supcomponent print outputs
mphstudios
reviewed
Dec 6, 2023
mphstudios
reviewed
Dec 6, 2023
Comment on lines
+1
to
+6
| <template webc:nokeep> | ||
| <canvas-panel webc:if="isCanvas(id)" @attributes="attributes(id, image_dir).canvasPanel"></canvas-panel> | ||
| <image-service webc:elseif="isImageService(id)" @attributes="attributes(id, image_dir).imageService"></image-service> | ||
| <image-sequence webc:elseif="isSequence(id)" @attributes="attributes(id, image_dir).imageSequence"></image-sequence> | ||
| <image-tag webc:else @attributes="attributes(id, image_dir).imageTag"></image-tag> | ||
| </template> |
There was a problem hiding this comment.
Could the template be written using a dynamic webc component, webc:is="component(id)", rather than a webc conditional statements?
There was a problem hiding this comment.
Apparently webc:is does not support dynamic values; see 11ty/webc#143
There was a problem hiding this comment.
We might add a comment on the implementation quirks, something like
<!---
Nota bene: `webc:is` does not support dynamic values (see 11ty/webc#143);
use webc conditional statements and call the `attributes` function multiple times rather than using a fancier pattern of implementation.
--->
mphstudios
reviewed
Dec 6, 2023
Co-authored-by: matthew p hrudka <mphstudios@users.noreply.github.com>
mphstudios
approved these changes
Dec 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds:
_components/quire-figure.webc: defines a<figure>with anidand conditionally rendersfigureAudio,figureTable,figureVideo, andfigureImageWebc_components/figure-image.webc: conditionally renders<canvas-panel>,<image-sequence>,<image-service>, and<image-tag>components based onmediaType. Registered as an eleventy shortcode namedfigureImageWebc_components/image-tag.webc: renders a<img>tag with alt textNote: Media embed links in video/audio figures are currently rendering in web output; these links should only show in print output. Image Sequences still need to be addressed as well -- see https://jira.getty.edu/browse/DEV-16542
@mphstudios I was originally planning on doing these figure image component webc refactors in isolation, but refactoring the
_plugins/shortcodes/figure.jsto renderquire-figure.webcended up being much simpler -- we can still use the JS components for video, audio, and table figures via@html="...". Interestingly enough, none of these actually need thequire-dataJSON since we can just use ourgetFigure(id)filter -- I anticipate that will still be necessary / useful for refactoring the lightbox/modal.