figure

This reference guide describes the figure partial arguments.

Example#

{{- $opts := dict
  "page" .
  "src" "images/bryce-canyon-national-park.jpg"
  "width" 768
  "sizes" "auto"
  "formats" (slice "webp" "jpeg")
  "process" "fill 1600x900"
  "lqip" "16x webp q20"
  "decoding" "async"
  "fetchpriority" "auto"
  "loading" "eager"
  "alt" "Bryce Canyon National Park"
  "title" "A beautiful day in Bryce Canyon National Park"
  "caption" "Bryce Canyon National Park"
  "class" "foo"
}}
{{- partial "figure.html" $opts }}

Arguments#

The page and src arguments are required; others are optional.

page#

The current page (.) — the partial’s context.

src#

A string containing the path to the image. See Image placement for supported locations and syntax.

width#

The display width of the image in pixels. An integer — for example 768.

sizes#

The value used for the sizes attribute on responsive images. A string — for example auto or 75vw.

formats#

The image formats used to build srcset candidates, ordered by precedence. A comma-separated string — for example webp, jpeg.

process#

The Hugo image processing specification applied to the main generated image. A string — for example fill 1600x900.

lqip#

The Hugo resize specification used to generate the low-quality image placeholder. A string — for example 16x webp q20.

decoding#

The decoding hint applied to the generated img element. A string — valid values are sync, async, and auto. If omitted, the partial uses thulite_images.defaults.decoding.

fetchpriority#

The fetch priority hint applied to the generated img element. A string — valid values are high, low, and auto. If omitted, the partial uses thulite_images.defaults.fetchpriority.

loading#

The loading behavior applied to the generated img element. A string — valid values are eager and lazy. If omitted, the partial uses thulite_images.defaults.loading.

alt#

The alt attribute applied to the generated img element. A string.

title#

The title attribute applied to the generated img element. A string.

caption#

The figcaption element content. A string.

class#

The class attribute applied to the generated img element. A string.