52 lines
1.4 KiB
Plaintext
52 lines
1.4 KiB
Plaintext
{% doc %}
|
|
Renders a responsive image that might be wrapped in a link.
|
|
|
|
When `width`, `height` and `crop` are provided, the image will be rendered
|
|
with a fixed aspect ratio.
|
|
|
|
Serves as an example of how to use the `image_url` filter and `image_tag` filter
|
|
as well as how you can use LiquidDoc to document your code.
|
|
|
|
@param {image} image - The image to be rendered
|
|
@param {string} [url] - An optional destination URL for the image
|
|
@param {string} [class] - Optional class to be added to the image wrapper
|
|
@param {number} [width] - The highest resolution width of the image to be rendered
|
|
@param {number} [height] - The highest resolution height of the image to be rendered
|
|
@param {string} [crop] - The crop position of the image
|
|
|
|
@example
|
|
{% render 'image', image: product.featured_image %}
|
|
{% render 'image', image: product.featured_image, url: product.url %}
|
|
{% render 'image',
|
|
class: 'product__image',
|
|
image: product.featured_image,
|
|
url: product.url,
|
|
width: 1200,
|
|
height: 800,
|
|
crop: 'center',
|
|
%}
|
|
{% enddoc %}
|
|
|
|
{% liquid
|
|
unless height
|
|
assign width = width | default: image.width
|
|
endunless
|
|
|
|
if url
|
|
assign wrapper = 'a'
|
|
else
|
|
assign wrapper = 'div'
|
|
endif
|
|
%}
|
|
|
|
<{{ wrapper }}
|
|
class="image {{ class }}"
|
|
{% if url %}
|
|
href="{{ url }}"
|
|
{% endif %}
|
|
>
|
|
{{ image | image_url: width: width, height: height, crop: crop | image_tag }}
|
|
</{{ wrapper }}>
|
|
|
|
|