diff options
-rw-r--r-- | layouts/_default/single.html | 2 | ||||
-rw-r--r-- | layouts/partials/tail.html | 10 | ||||
-rw-r--r-- | layouts/shortcodes/figure.html | 29 | ||||
-rw-r--r-- | layouts/shortcodes/gallery.html | 53 | ||||
-rw-r--r-- | layouts/shortcodes/load-photoswipe.html | 75 | ||||
-rw-r--r-- | static/css/hugo-easy-gallery.css | 159 | ||||
-rw-r--r-- | static/js/load-photoswipe.js | 80 |
7 files changed, 408 insertions, 0 deletions
diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 8b606f5..d4cdf05 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -22,6 +22,7 @@ </div> {{ end }} +{{/* {{ $images := .Resources.Match "images/*" }} {{ if gt (len $images) 0 }} <ul class="images-list" aria-hidden="true"> @@ -40,6 +41,7 @@ {{ end }} </ul> {{ end }} +*/}} {{ end }} {{ define "lists" }} diff --git a/layouts/partials/tail.html b/layouts/partials/tail.html index ac0526b..ed6fbd7 100644 --- a/layouts/partials/tail.html +++ b/layouts/partials/tail.html @@ -1,5 +1,15 @@ {{ "<!-- TAIL.HTML -->" | safeHTML }} +<!-- <script src="{{ "plugins/jquery/jquery.js" | absURL }}"></script> +--> +<script src="{{ "plugins/jquery/jquery.js" | absURL }}"></script> +<!-- Load PhotoSwipe js if the load-photoswipe shortcode has been used --> +{{ if ($.Scratch.Get "photoswipeloaded") }} +<script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script> +<script src="/js/load-photoswipe.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.1/photoswipe.min.js" integrity="sha256-UplRCs9v4KXVJvVY+p+RSo5Q4ilAUXh7kpjyIP5odyc=" crossorigin="anonymous"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.1/photoswipe-ui-default.min.js" integrity="sha256-PWHOlUzc96pMc8ThwRIXPn8yH4NOLu42RQ0b9SpnpFk=" crossorigin="anonymous"></script> +{{ end }} <script src="{{ "plugins/bootstrap/js/bootstrap.min.js" | absURL }}"></script> <script src="{{ "plugins/jquery/jquery.easing.min.js" | absURL }}"></script> <script src="{{ "plugins/jquery/jquery.fittext.js" | absURL }}"></script> diff --git a/layouts/shortcodes/figure.html b/layouts/shortcodes/figure.html new file mode 100644 index 0000000..4c6ff1f --- /dev/null +++ b/layouts/shortcodes/figure.html @@ -0,0 +1,29 @@ +<!-- +Put this file in /layouts/shortcodes/figure.html +NB this overrides Hugo's built-in "figure" shortcode but is backwards compatible +Documentation and licence at https://github.com/liwenyip/hugo-easy-gallery/ +--> +<!-- count how many times we've called this shortcode; load the css if it's the first time --> +{{- if not ($.Page.Scratch.Get "figurecount") }}<link rel="stylesheet" href="/css/hugo-easy-gallery.css" />{{ end }} +{{- $.Page.Scratch.Add "figurecount" 1 -}} +<!-- use either src or link-thumb for thumbnail image --> +{{- $thumb := .Get "src" | default (printf "%s." (.Get "thumb") | replace (.Get "link") ".") }} +<div class="box{{ with .Get "caption-position" }} fancy-figure caption-position-{{.}}{{end}}{{ with .Get "caption-effect" }} caption-effect-{{.}}{{end}}" {{ with .Get "width" }}style="max-width:{{.}}"{{end}}> + <figure {{ with .Get "class" }}class="{{.}}"{{ end }} itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject"> + <div class="img"{{ if .Parent }} style="background-image: url('{{ print .Site.BaseURL $thumb }}');"{{ end }}{{ with .Get "size" }} data-size="{{.}}"{{ end }}> + <img itemprop="thumbnail" src="{{ $thumb }}" {{ with .Get "alt" | default (.Get "caption") }}alt="{{.}}"{{ end }}/><!-- <img> hidden if in .gallery --> + </div> + {{ with .Get "link" | default (.Get "src") }}<a href="{{.}}" itemprop="contentUrl"></a>{{ end }} + {{- if or (or (.Get "title") (.Get "caption")) (.Get "attr")}} + <figcaption> + {{- with .Get "title" }}<h4>{{.}}</h4>{{ end }} + {{- if or (.Get "caption") (.Get "attr")}} + <p> + {{- .Get "caption" -}} + {{- with .Get "attrlink"}}<a href="{{.}}">{{ .Get "attr" }}</a>{{ else }}{{ .Get "attr"}}{{ end -}} + </p> + {{- end }} + </figcaption> + {{- end }} + </figure> +</div> diff --git a/layouts/shortcodes/gallery.html b/layouts/shortcodes/gallery.html new file mode 100644 index 0000000..ab8671b --- /dev/null +++ b/layouts/shortcodes/gallery.html @@ -0,0 +1,53 @@ +<!-- +Put this file in /layouts/shortcodes/gallery.html +Documentation and licence at https://github.com/liwenyip/hugo-easy-gallery/ +--> +<!-- count how many times we've called this shortcode; load the css if it's the first time --> +{{- if not ($.Page.Scratch.Get "figurecount") }}<link rel="stylesheet" href="/css/hugo-easy-gallery.css" />{{ end }} +{{- $.Page.Scratch.Add "figurecount" 1 }} +{{ $baseURL := .Site.BaseURL }} +<div class="gallery caption-position-{{ with .Get "caption-position" | default "bottom" }}{{.}}{{end}} caption-effect-{{ with .Get "caption-effect" | default "slide" }}{{.}}{{end}} hover-effect-{{ with .Get "hover-effect" | default "zoom" }}{{.}}{{end}} {{ if ne (.Get "hover-transition") "none" }}hover-transition{{end}}" itemscope itemtype="http://schema.org/ImageGallery"> + {{- with (.Get "dir") -}} + <!-- If a directory was specified, generate figures for all of the images in the directory --> + {{- if eq ($.Get "static") "true" -}} + {{ $.Page.Scratch.Set "dirURL" (print .) }} + {{ $.Page.Scratch.Set "dirFiles" (print "/static/" .) }} + {{- else -}} + {{- $dir := print (replace $.Page.Dir "\\" "/") "/" . }} + {{ $.Page.Scratch.Set "dirURL" $dir }} + {{ $.Page.Scratch.Set "dirFiles" (print "/content/" $dir "/") }} + {{- end -}} + {{- $dir := $.Page.Scratch.Get "dirURL" }} + {{- $files := readDir ($.Page.Scratch.Get "dirFiles" ) }} + {{ $.Page.Scratch.Delete "dirURL" }} + {{ $.Page.Scratch.Delete "dirFiles" }} + + {{- range $files -}} + <!-- skip files that aren't images, or that inlcude the thumb suffix in their name --> + {{- $thumbext := $.Get "thumb" | default "-thumb" }} + {{- $isthumb := .Name | findRE ($thumbext | printf "%s\\.") }}<!-- is the current file a thumbnail image? --> + {{- $isimg := lower .Name | findRE "\\.(gif|jpg|jpeg|tiff|png|bmp)" }}<!-- is the current file an image? --> + {{- if and $isimg (not $isthumb) }} + {{- $caption := .Name | replaceRE "\\..*" "" | humanize }}<!-- humanized filename without extension --> + {{- $linkURL := print $baseURL $dir "/" .Name | absURL }}<!-- absolute URL to hi-res image --> + {{- $thumb := .Name | replaceRE "(\\.)" ($thumbext | printf "%s.") }}<!-- filename of thumbnail image --> + {{- $thumbexists := where $files "Name" $thumb }}<!-- does a thumbnail image exist? --> + {{- $thumbURL := print $baseURL $dir "/" $thumb | absURL }}<!-- absolute URL to thumbnail image --> + <div class="box"> + <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject"> + <div class="img" style="background-image: url('{{ if $thumbexists }}{{ $thumbURL }}{{ else }}{{ $linkURL }}{{ end }}');" > + <img itemprop="thumbnail" src="{{ if $thumbexists }}{{ $thumbURL }}{{ else }}{{ $linkURL }}{{ end }}" alt="{{ $caption }}" /><!-- <img> hidden if in .gallery --> + </div> + <figcaption> + <p>{{ $caption }}</p> + </figcaption> + <a href="{{ $linkURL }}" itemprop="contentUrl"></a><!-- put <a> last so it is stacked on top --> + </figure> + </div> + {{- end }} + {{- end }} + {{- else -}} + <!-- If no directory was specified, include any figure shortcodes called within the gallery --> + {{ .Inner }} + {{- end }} +</div> diff --git a/layouts/shortcodes/load-photoswipe.html b/layouts/shortcodes/load-photoswipe.html new file mode 100644 index 0000000..4b3bfad --- /dev/null +++ b/layouts/shortcodes/load-photoswipe.html @@ -0,0 +1,75 @@ +<!-- +Put this file in /layouts/shortcodes/load-photoswipe.html +Documentation and licence at https://github.com/liwenyip/hugo-easy-gallery/ +--> + +<!-- prevent this shortcode from being loaded more than once per page --> +{{ if not ($.Page.Scratch.Get "photoswipeloaded") }} + {{ $.Page.Scratch.Set "photoswipeloaded" 1 }} + +<!-- +*** jQuery must be loaded before load-photoswipe.js *** +- If your template already loads jQuery in the header then you don't need to load it again here. +- If your template already loads jQuery in the footer, then you could load load-photoswipe.js from the footer instead +--> +<!-- these files are loaded in the theme footer +<script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script> +<script src="/js/load-photoswipe.js"></script> +--> + +<!-- Photoswipe css/js libraries --> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.1/photoswipe.min.css" integrity="sha256-sCl5PUOGMLfFYctzDW3MtRib0ctyUvI9Qsmq2wXOeBY=" crossorigin="anonymous" /> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.1/default-skin/default-skin.min.css" integrity="sha256-BFeI1V+Vh1Rk37wswuOYn5lsTcaU96hGaI7OUVCLjPc=" crossorigin="anonymous" /> +<!-- these files are loaded in the theme footer +<script src="https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.1/photoswipe.min.js" integrity="sha256-UplRCs9v4KXVJvVY+p+RSo5Q4ilAUXh7kpjyIP5odyc=" crossorigin="anonymous"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.1/photoswipe-ui-default.min.js" integrity="sha256-PWHOlUzc96pMc8ThwRIXPn8yH4NOLu42RQ0b9SpnpFk=" crossorigin="anonymous"></script> +--> + +<!-- Root element of PhotoSwipe. Must have class pswp. --> +<div class="pswp" tabindex="-1" role="dialog" aria-hidden="true"> +<!-- Background of PhotoSwipe. + It's a separate element, as animating opacity is faster than rgba(). --> +<div class="pswp__bg"></div> +<!-- Slides wrapper with overflow:hidden. --> +<div class="pswp__scroll-wrap"> + <!-- Container that holds slides. + PhotoSwipe keeps only 3 of them in DOM to save memory. + Don't modify these 3 pswp__item elements, data is added later on. --> + <div class="pswp__container"> + <div class="pswp__item"></div> + <div class="pswp__item"></div> + <div class="pswp__item"></div> + </div> + <!-- Default (PhotoSwipeUI_Default) interface on top of sliding area. Can be changed. --> + <div class="pswp__ui pswp__ui--hidden"> + <div class="pswp__top-bar"> + <!-- Controls are self-explanatory. Order can be changed. --> + <div class="pswp__counter"></div> + <button class="pswp__button pswp__button--close" title="Close (Esc)"></button> + <button class="pswp__button pswp__button--share" title="Share"></button> + <button class="pswp__button pswp__button--fs" title="Toggle fullscreen"></button> + <button class="pswp__button pswp__button--zoom" title="Zoom in/out"></button> + <!-- Preloader demo http://codepen.io/dimsemenov/pen/yyBWoR --> + <!-- element will get class pswp__preloader--active when preloader is running --> + <div class="pswp__preloader"> + <div class="pswp__preloader__icn"> + <div class="pswp__preloader__cut"> + <div class="pswp__preloader__donut"></div> + </div> + </div> + </div> + </div> + <div class="pswp__share-modal pswp__share-modal--hidden pswp__single-tap"> + <div class="pswp__share-tooltip"></div> + </div> + <button class="pswp__button pswp__button--arrow--left" title="Previous (arrow left)"> + </button> + <button class="pswp__button pswp__button--arrow--right" title="Next (arrow right)"> + </button> + <div class="pswp__caption"> + <div class="pswp__caption__center"></div> + </div> + </div> + </div> +</div> +{{ end }}
\ No newline at end of file diff --git a/static/css/hugo-easy-gallery.css b/static/css/hugo-easy-gallery.css new file mode 100644 index 0000000..d78dfec --- /dev/null +++ b/static/css/hugo-easy-gallery.css @@ -0,0 +1,159 @@ +/* +Put this file in /static/css/hugo-easy-gallery.css +Documentation and licence at https://github.com/liwenyip/hugo-easy-gallery/ +*/ + + +/* +Grid Layout Styles +*/ +.gallery { + overflow: hidden; + margin: 10px; + max-width: 768px; +} +.gallery .box { + float: left; + position: relative; + /* Default: 1 tile wide */ + width: 100%; + padding-bottom: 100%; +} +@media only screen and (min-width : 365px) { + /* Tablet view: 2 tiles */ + .gallery .box { + width: 50%; + padding-bottom: 50%; + } +} +@media only screen and (min-width : 480px) { + /* Small desktop / ipad view: 3 tiles */ + .gallery .box { + width: 33.3%; + padding-bottom: 33.3%; /* */ + } +} +@media only screen and (min-width : 9999px) { + /* Medium desktop: 4 tiles */ + .box { + width: 25%; + padding-bottom: 25%; + } +} + +/* +Transition styles +*/ +.gallery.hover-transition figure, +.gallery.hover-effect-zoom .img, +.gallery:not(.caption-effect-appear) figcaption, +.fancy-figure:not(.caption-effect-appear) figcaption { + -webkit-transition: all 0.3s ease-in-out; + -moz-transition: all 0.3s ease-in-out; + -o-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; +} +/* +figure styles +*/ +figure { + position:relative; /* purely to allow absolution positioning of figcaption */ + overflow: hidden; +} +.gallery figure { + position: absolute; + left: 5px; + right: 5px; + top: 5px; + bottom: 5px; +} +.gallery.hover-effect-grow figure:hover { + transform: scale(1.05); +} +.gallery.hover-effect-shrink figure:hover { + transform: scale(0.95); +} +.gallery.hover-effect-slidedown figure:hover { + transform: translateY(5px); +} +.gallery.hover-effect-slideup figure:hover { + transform: translateY(-5px); +} + +/* +img / a styles +*/ + +.gallery .img { + position: absolute; + left: 0; + right: 0; + top: 0; + bottom: 0; + background-size: cover; + background-position: 50% 50%; + background-repeat: no-repeat; +} +.gallery.hover-effect-zoom figure:hover .img { + transform: scale(1.05); +} +.gallery img { + display: none; /* only show the img if not inside a gallery */ +} +figure a { + position: absolute; + left: 0; + right: 0; + top: 0; + bottom: 0; +} + +/* +figcaption styles +*/ +.gallery figcaption, +.fancy-figure figcaption { + position: absolute; + bottom: 0; + left: 0; + right: 0; + background: #000; + color: #FFF; + text-align: center; + font-size: 75%; /* change this if you want bigger text */ + background: rgba(0, 0, 0, 0.5); + opacity: 1; + cursor: pointer; +} +.gallery.caption-position-none figcaption, +.fancy-figure.caption-position-none figcaption { + display: none; +} +.gallery.caption-position-center figcaption, +.fancy-figure.caption-position-center figcaption { + top: 0; + padding: 40% 5px; +} +.gallery.caption-position-bottom figcaption, +.fancy-figure.caption-position-bottom figcaption { + padding: 5px; +} +.gallery.caption-effect-fade figure:not(:hover) figcaption, +.gallery.caption-effect-appear figure:not(:hover) figcaption, +.fancy-figure.caption-effect-fade figure:not(:hover) figcaption, +.fancy-figure.caption-effect-appear figure:not(:hover) figcaption { + background: rgba(0, 0, 0, 0); + opacity: 0; +} +.gallery.caption-effect-slide.caption-position-bottom figure:not(:hover) figcaption, +.fancy-figure.caption-effect-slide.caption-position-bottom figure:not(:hover) figcaption { + margin-bottom: -100%; +} +.gallery.caption-effect-slide.caption-position-center figure:not(:hover) figcaption, +.fancy-figure.caption-effect-slide.caption-position-center figure:not(:hover) figcaption { + top: 100%; +} +figcaption p { + margin: auto; /* override style in theme */ +} + diff --git a/static/js/load-photoswipe.js b/static/js/load-photoswipe.js new file mode 100644 index 0000000..978c66d --- /dev/null +++ b/static/js/load-photoswipe.js @@ -0,0 +1,80 @@ +/* +Put this file in /static/js/load-photoswipe.js +Documentation and licence at https://github.com/liwenyip/hugo-easy-gallery/ +*/ + +/* Show an alert if this js file has been loaded twice */ +if (window.loadphotoswipejs) { + window.alert("You've loaded load-photoswipe.js twice. See https://github.com/liwenyip/hugo-easy-gallery/issues/6") +} +var loadphotoswipejs = 1 + +/* TODO: Make the share function work */ +$( document ).ready(function() { + /* + Initialise Photoswipe + */ + var items = []; // array of slide objects that will be passed to PhotoSwipe() + // for every figure element on the page: + $('figure').each( function() { + if ($(this).attr('class') == 'no-photoswipe') return true; // ignore any figures where class="no-photoswipe" + // get properties from child a/img/figcaption elements, + var $figure = $(this), + $a = $figure.find('a'), + $img = $figure.find('img'), + $src = $a.attr('href'), + $title = $img.attr('alt'), + $msrc = $img.attr('src'); + // if data-size on <a> tag is set, read it and create an item + if ($a.data('size')) { + var $size = $a.data('size').split('x'); + var item = { + src : $src, + w : $size[0], + h : $size[1], + title : $title, + msrc : $msrc + }; + console.log("Using pre-defined dimensions for " + $src); + // if not, set temp default size then load the image to check actual size + } else { + var item = { + src : $src, + w : 800, // temp default size + h : 600, // temp default size + title : $title, + msrc : $msrc + }; + console.log("Using default dimensions for " + $src); + // load the image to check its dimensions + // update the item as soon as w and h are known (check every 30ms) + var img = new Image(); + img.src = $src; + var wait = setInterval(function() { + var w = img.naturalWidth, + h = img.naturalHeight; + if (w && h) { + clearInterval(wait); + item.w = w; + item.h = h; + console.log("Got actual dimensions for " + img.src); + } + }, 30); + } + // Save the index of this image then add it to the array + var index = items.length; + items.push(item); + // Event handler for click on a figure + $figure.on('click', function(event) { + event.preventDefault(); // prevent the normal behaviour i.e. load the <a> hyperlink + // Get the PSWP element and initialise it with the desired options + var $pswp = $('.pswp')[0]; + var options = { + index: index, + bgOpacity: 0.8, + showHideOpacity: true + } + new PhotoSwipe($pswp, PhotoSwipeUI_Default, items, options).init(); + }); + }); +});
\ No newline at end of file |