✨feat(image shortcodes): add lazy loading (#116)

Additionally sets the `alt` parameters as optional and cleans HTML output.

templates/shortcodes/dimmable_image.html

@@ -1,8 +1,10 @@
-{% set meta = get_image_metadata(path=src, allow_missing=true) %}
+{%- set meta = get_image_metadata(path=src, allow_missing=true) -%}
+{%- set lazy_loading = lazy_loading | default(value=true) -%}
+
 {% if full_width | default(value=false) %}
     <div class="full-width">
 {% endif %}
-<img class="dimmable-image" src="{{ get_url(path=src) }}" {% if alt %}alt="{{ alt }}" {% endif %} {% if meta.width %}width="{{ meta.width }}" {% endif %} {% if meta.height %}height="{{ meta.height }}" {% endif %}/>
+<img class="dimmable-image" src="{{ get_url(path=src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if alt %} alt="{{ alt }}"{% endif %}{% if meta.width %} width="{{ meta.width }}"{% endif %}{% if meta.height %} height="{{ meta.height }}" {% endif %}/>
 {% if full_width | default(value=false) %}
     </div>
 {% endif %}

templates/shortcodes/dual_theme_image.html

@@ -1,10 +1,12 @@
-{% set light_meta = get_image_metadata(path=light_src, allow_missing=true) %}
-{% set dark_meta = get_image_metadata(path=dark_src, allow_missing=true) %}
-{% if full_width | default(value=false) %}
+{%- set light_meta = get_image_metadata(path=light_src, allow_missing=true) -%}
+{%- set dark_meta = get_image_metadata(path=dark_src, allow_missing=true) -%}
+{%- set lazy_loading = lazy_loading | default(value=true) -%}
+
+{%- if full_width | default(value=false) -%}
     <div class="full-width">
-{% endif %}
-<img src="{{ get_url(path=light_src) }}" {% if alt %}alt="{{ alt }}" {% endif %} {% if light_meta.width %}width="{{ light_meta.width }}" {% endif %} {% if light_meta.height %}height="{{ light_meta.height }}" {% endif %} class="img-light">
-<img src="{{ get_url(path=dark_src) }}" {% if alt %}alt="{{ alt }}" {% endif %} {% if dark_meta.width %}width="{{ dark_meta.width }}" {% endif %} {% if dark_meta.height %}height="{{ dark_meta.height }}" {% endif %} class="img-dark">
+{%- endif -%}
+<img src="{{ get_url(path=light_src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if alt %} alt="{{ alt }}"{% endif %}{% if light_meta.width %} width="{{ light_meta.width }}"{% endif %}{% if light_meta.height %} height="{{ light_meta.height }}"{% endif %} class="img-light">
+<img src="{{ get_url(path=dark_src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if alt %} alt="{{ alt }}"{% endif %}{% if dark_meta.width %} width="{{ dark_meta.width }}"{% endif %}{% if dark_meta.height %} height="{{ dark_meta.height }}"{% endif %} class="img-dark">
 {% if full_width | default(value=false) %}
     </div>
 {% endif %}

templates/shortcodes/full_width_image.html

@@ -1,4 +1,6 @@
-{% set meta = get_image_metadata(path=src, allow_missing=true) %}
+{%- set meta = get_image_metadata(path=src, allow_missing=true) -%}
+{%- set lazy_loading = lazy_loading | default(value=true) -%}
+
 <div class="full-width">
-<img {% if src %}src="{{ get_url(path=src) }}" {% endif %} {% if alt %}alt="{{ alt }}" {% endif %} {% if meta.width %}width="{{ meta.width }}" {% endif %} {% if meta.height %}height="{{ meta.height }}" {% endif %}/>
+    <img src="{{ get_url(path=src) }}"{% if alt %} alt="{{ alt }}"{% endif %}{% if meta.width %} width="{{ meta.width }}"{% endif %}{% if meta.height %} height="{{ meta.height }}"{% endif %}{% if lazy_loading %} loading="lazy"{% endif %}/>
 </div>

templates/shortcodes/image_hover.html

@@ -1,13 +1,12 @@
 {%- set default_meta = get_image_metadata(path=default_src, allow_missing=true) -%}
 {%- set hovered_meta = get_image_metadata(path=hovered_src, allow_missing=true) -%}
+{%- set lazy_loading = lazy_loading | default(value=true) -%}
 
-<div class="image-hover-container {% if full_width | default(value=false) %}full-width{% endif %}">
+<div class="image-hover-container{% if full_width | default(value=false) %} full-width{% endif %}">
     <div class="image-default">
-        <img src="{{ get_url(path=default_src) }}" alt="{{ default_alt }}"
-            width="{{ default_meta.width }}" height="{{ default_meta.height }}">
+        <img src="{{ get_url(path=default_src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if hovered_alt %} alt="{{ default_alt }}"{% endif %}{% if default_meta.width %} width="{{ default_meta.width }}"{% endif %}{% if default_meta.height %} height="{{ default_meta.height }}"{% endif %}>
     </div>
     <div class="image-hovered">
-        <img src="{{ get_url(path=hovered_src) }}" alt="{{ hovered_alt }}"
-            width="{{ hovered_meta.width }}" height="{{ hovered_meta.height }}">
+        <img src="{{ get_url(path=hovered_src) }}"{% if hovered_alt %} alt="{{ hovered_alt }}"{% endif %}{% if hovered_meta.width %} width="{{ hovered_meta.width }}"{% endif %}{% if hovered_meta.height %} height="{{ hovered_meta.height }}"{% endif %}>
     </div>
 </div>

templates/shortcodes/image_toggler.html

@@ -2,20 +2,18 @@
 {# allowing individual interactive elements (like toggles) to function correctly. #}
 {# This avoids conflicts when multiple instances of the shortcode are used. #}
 {%- set random_id = get_random(end=100000) -%}
-
-{% set default_meta = get_image_metadata(path=default_src, allow_missing=true) %}
-{% set toggled_meta = get_image_metadata(path=toggled_src, allow_missing=true) %}
+{%- set default_meta = get_image_metadata(path=default_src, allow_missing=true) -%}
+{%- set toggled_meta = get_image_metadata(path=toggled_src, allow_missing=true) -%}
+{%- set lazy_loading = lazy_loading | default(value=true) -%}
 
 <div class="image-toggler-container {% if full_width | default(value=false) %}full-width{% endif %}">
     <input type="checkbox" id="toggle-img-{{ random_id }}" class="image-toggler-toggle">
     <label for="toggle-img-{{ random_id }}" class="image-label">
         <div class="image-default">
-            <img src="{{ get_url(path=default_src) }}" alt="{{ default_alt }}"
-                width="{{ default_meta.width }}" height="{{ default_meta.height }}">
+            <img src="{{ get_url(path=default_src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if default_alt %} alt="{{ default_alt }}"{% endif %}{% if default_meta.width %} width="{{ default_meta.width }}"{% endif %}{% if default_meta.height %} height="{{ default_meta.height }}"{% endif %}>
         </div>
         <div class="image-toggled">
-            <img src="{{ get_url(path=toggled_src) }}" alt="{{ toggled_alt }}"
-                width="{{ toggled_meta.width }}" height="{{ toggled_meta.height }}">
+            <img src="{{ get_url(path=toggled_src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if toggled_alt %} alt="{{ toggled_alt }}"{% endif %}{% if toggled_meta.width %} width="{{ toggled_meta.width }}"{% endif %}{% if toggled_meta.height %} height="{{ toggled_meta.height }}"{% endif %}>
         </div>
     </label>
 </div>

templates/shortcodes/invertible_image.html

@@ -1,8 +1,10 @@
-{% set meta = get_image_metadata(path=src, allow_missing=true) %}
+{%- set meta = get_image_metadata(path=src, allow_missing=true) -%}
+{%- set lazy_loading = lazy_loading | default(value=true) -%}
+
 {% if full_width | default(value=false) %}
     <div class="full-width">
 {% endif %}
-<img class="invertible-image" {% if src %}src="{{ get_url(path=src) }}" {% endif %} {% if alt %}alt="{{ alt }}" {% endif %} {% if meta.width %}width="{{ meta.width }}" {% endif %} {% if meta.height %}height="{{ meta.height }}" {% endif %}/>
-{% if full_width | default(value=false) %}
+<img class="invertible-image" src="{{ get_url(path=src) }}"{% if lazy_loading %} loading="lazy"{% endif %}{% if alt %} alt="{{ alt }}"{% endif %}{% if meta.width %} width="{{ meta.width }}"{% endif %}{% if meta.height %} height="{{ meta.height }}" {% endif %}/>
+{%- if full_width | default(value=false) -%}
     </div>
-{% endif %}
+{%- endif -%}