| title | description | summary | date | lastmod | draft | menu | weight | toc | seo | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
img |
2023-11-28 14:24:00 +0100 |
2023-11-28 14:24:00 +0100 |
false |
|
932 |
true |
|
This reference guide describes the img partial arguments.
The page and src arguments are required; others are optional.
The current page (.) — the partial's context.
A string containing the path to the image — a page resource, a global resource, or a remote resource.
Integer containing the display width of the image in pixels, falling back to 100% of the viewport width — for example 320.
A string containing a comma-separated list of source size descriptors followed by an optional fallback size — for example 75vw. Recommended resources:
- HTMLImageElement: sizes property
- sizes=auto is a great idea
- Responsive Images - Serve Scaled Images
- Applying srcset: choosing the right sizes for responsive images at different breakpoints
A string slice of image formats, ordered by precedence, used when creating images for the srcset attribute of each source element — for example webp, jpeg.
A string containing a Hugo process method — for example fill 1600x900.
A string containing a Hugo resize method — for example 16x webp q20.
A string representing the decoding hint. Possible values are:
sync
: Decode the image synchronously for atomic presentation with other content.
async
: Decode the image asynchronously and allow other content to be rendered before this completes.
auto
: No preference for the decoding mode; the browser decides what is best for the user. This is the default value, but different browsers have different defaults:
- Chromium defaults to
sync. - Firefox defaults to
async. - Safari defaults to
syncexcept in a small number of circumstances.
A string representing the priority hint. Possible values are:
high
: Fetch the image at a high priority relative to other images.
low
: Fetch the image at a low priority relative to other images.
auto
: Default mode, which indicates no preference for the fetch priority. The browser decides what is best for the user.
A string providing a hint to the user agent as to how to best schedule the loading of the image to optimize page performance. The possible values are:
eager
: The default behavior, eager tells the browser to load the image as soon as the <img> element is processed.
lazy
: Tells the user agent to hold off on loading the image until the browser estimates that it will be needed imminently. For instance, if the user is scrolling through the document, a value of lazy will cause the image to only be loaded shortly before it will appear in the window's visual viewport.
String containing the img element's alt attribute.
String containing the img element's title attribute.
String containing the img element's class attribute.