jekyll-page-asset 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4bc75d0d43f30ae672d870c5e0a6cf6f59c5d4c5e265defae10c1ecaca01d8c
-  data.tar.gz: a248414dec9ef31592ae271ee6648f6f50ed4d2deb98d1891dd43df1e680515e
+  metadata.gz: 4d6d2997cebfa6648d100a3335cf78425358a609ad5d524eb38d5ee4671d0b32
+  data.tar.gz: 70559d1c925bc506b6f037b4fdd1d2fc5e8989e359f9755fdc85e9b97e0cabb7
 SHA512:
-  metadata.gz: 02ba586c38e6b1c12116b0b485d7c260fce71ee3d3eb3e8d270e8302fc70ca65990fab037f9f59a632eb602091dbcb7f5b6f2ab001729a2ac84ca35f2d18da70
-  data.tar.gz: 9a76aea336af968aef5452afde8f8dddd314d63b629cea171bae8f0f71fd4bf3d3827be0f7af8a7f70221570cdc5a6a66a7b75b8ce59b8d9dafd73b07ef42eab
+  metadata.gz: 2b56178cd9e58f14ce07230045a85528fdf11a0189095ae75fcd242711859170f78dd4a983daad8db5d6ab3d29c951353ae2daf628127214d4e57a4460943dfa
+  data.tar.gz: '0890f071dd316148b87d3f470a9ce88c160f094b8936c2aba6f1fdda19f5a2e273b9e383efaef08fbe622fa45524d287a3c2dfed19abaee60950cdcb7962ba21'

data/README.md

@@ -38,10 +38,13 @@ Pass a folder name in the media asset directory and all images in that folder wi
 
 The generated html and script for this will also write tags to two target mount points in the site, if found.
 
-* `project-asset-gallery-lightbox` is the target for the lightbox html. By default this is styled to fill the viewport area of the component that it is mounted in to act as a full area takeover.
+* `page-asset-gallery-lightbox` is the target for the lightbox html. By default this is styled to fill the viewport area of the component that it is mounted in to act as a full area takeover. This is optional, but if not included, the gallery will only display as thumbnails and cannot be expanded.
+
+* `page-asset-gallery-controls` is the target for the gallery controls - to move to next/previous images and close the lightbox. This appears when the lightbox is open. Optional, if not included, the controls will be rendered at the top of the lightbox.
+
+Gallery can take optional `title` and `description` arguments to provide a heading and descriptive text for the gallery.
+`{% page_asset gallery <gallery-folder-name> [title="<title-text>"] [description="<description-text>"] %}`
 
-* `project-asset-gallery-controls` is the target for the gallery controls - to move to next/previous images and close the lightbox. This appears when the lightbox is open.
-`{% page_asset gallery <gallery-folder-name> %}`
 
 
 ### fountain script reader

data/_includes/page_asset/gallery.html

@@ -21,6 +21,16 @@
         lightboxMount.setAttribute(MOUNTED_ATTR, "true");
       }
 
+      if (!controlsMount) {
+        var fallbackControlsDiv = document.createElement("div");
+        fallbackControlsDiv.id = "page-asset-gallery-controls-fallback";
+        fallbackControlsDiv.className = "gallery-controls-fallback";
+        if (lightboxMount) {
+          lightboxMount.insertBefore(fallbackControlsDiv, lightboxMount.firstChild);
+        }
+        controlsMount = fallbackControlsDiv;
+      }
+
       if (controlsMount) {
         controlsMount.innerHTML =
           '<div class="gallery-controls" id="gallery-controls" hidden aria-label="Gallery controls">' +

data/_lib/page_asset/gallery_renderer.rb

@@ -45,9 +45,12 @@ module Jekyll
           HTML
         end
 
+        title_html = render_title(@params["title"])
+        description_html = render_description(@params["description"])
+
         <<~HTML + gallery_template
           <section class="project-gallery" data-gallery="#{html_escape(@asset_path_arg)}" aria-label="Image gallery">
-            <div class="project-gallery-grid">
+            #{title_html}#{description_html}<div class="project-gallery-grid">
               #{thumbnails.join("\n")}
             </div>
           </section>
@@ -108,6 +111,16 @@ module Jekyll
         HTML
       end
 
+      def render_title(title)
+        return "" if title.nil? || title.to_s.strip.empty?
+        "<h2 class=\"project-gallery-title\">#{html_escape(title)}</h2>\n"
+      end
+
+      def render_description(description)
+        return "" if description.nil? || description.to_s.strip.empty?
+        "<p class=\"project-gallery-description\">#{html_escape(description)}</p>\n"
+      end
+
       def html_escape(value)
         CGI.escape_html(value.to_s)
       end

data/_sass/_page-asset.scss

@@ -171,6 +171,7 @@
     width: 100%;
     height: 100%;
     position: absolute;
+    pointer-events: none;
 }
 
 #page-asset-gallery-controls {
@@ -199,6 +200,15 @@
     }
 }
 
+.gallery-controls-fallback {
+    position: relative;
+    width: 100%;
+    padding: $spacing-sm 0;
+    background: transparent;
+    pointer-events: all;
+    z-index: 221;
+}
+
 .gallery-lightbox-desc {
     margin-top: $spacing-md;
 }

data/lib/jekyll-page-asset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllPageAsset
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-page-asset
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alastair King