Parameters

This reference guide describes the Images module parameters.

Example#

# Images (@thulite/images)
[thulite_images]
  [thulite_images.defaults]
    decoding = "async" # sync, async, or auto (default)
    fetchpriority = "auto" # high, low, or auto (default)
    loading = "lazy" # eager or lazy (default)
    widths = [480, 576, 768, 1025, 1200, 1440] # [640, 768, 1024, 1366, 1600, 1920] for example
    sizes = "auto" # 100vw (default), 75vw, or auto for example
    process = "" # "fill 1600x900" or "fill 2100x900" for example
    lqip = "16x webp q20" # "16x webp q20" or "21x webp q20" for example

thulite_images.defaults#

Default rendering and processing parameters for generated images.

decoding#

The default decoding hint applied to generated img elements. A string — valid values are sync, async, and auto. Default is "async".

fetchpriority#

The default fetch priority hint applied to generated img elements. A string — valid values are high, low, and auto. Default is "auto".

loading#

The default loading behavior applied to generated img elements. A string — valid values are eager and lazy. Default is "lazy".

widths#

The responsive image widths used to build srcset candidates. An array of integers ordered from smallest to largest — default is [480, 576, 768, 1025, 1200, 1440].

sizes#

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

process#

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

lqip#

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