1
0
mirror of https://github.com/locomotivemtl/locomotive-boilerplate.git synced 2026-01-15 00:55:08 +08:00

Add default image snippet

This commit is contained in:
Lucas Bigot
2024-03-29 11:14:01 -04:00
parent 375b54150e
commit 171aa29a12
2 changed files with 116 additions and 1 deletions

95
views/snippets/image.twig Normal file
View File

@@ -0,0 +1,95 @@
{#
Image snippet
The `img` parameter was made to receive formatted data from a CMS.
The use case would be to output an image without overriding is dimensions or other properties.
It needs to be an object with the following keys :
-src: String,
-width: Int,
-height: Int,
-alt?: String,
-caption?: String
```twig
{% include '@snippets/image.twig' with
img: project.featured_image
%}
```
#}
{# Defaults #}
{% set _width = img.width | default(1) %}
{% set _height = img.height | default(1) %}
{% set _src = img.src | default(null) %}
{% set _alt = img.alt | default(null) %}
{% set _caption = img.caption | default(null) %}
{% set _attr = attr | default(null) %}
{% set _has_parallax = has_parallax | default(null) %}
{% set _parallax_speed = parallax_speed | default('-0.1') %}
{# Override properties #}
{% set _width = width | default(_width) %}
{% set _height = height | default(_height) %}
{% set _src = src | default(_src) %}
{% set _alt = alt | default(_alt) %}
{% set _caption = caption | default(_caption) %}
{# Misc. #}
{% set _is_figure = is_figure | default(false) %}
{% set _is_lazy_load = is_lazy_load | default(true) %}
{% set _tag = _is_figure ? 'figure' : 'div' %}
{# Classes & modifiers #}
{% set _classes = classes | default(null) %}
{% set _modifiers = modifiers | default(null) %}
{% if _has_parallax %}
{% set _modifiers = _modifiers ~ ' -parallax' %}
{% endif %}
{% if _is_lazy_load %}
{% set _modifiers = _modifiers ~ ' -lazy-load' %}
{% set _loading = 'lazy' %}
{% else %}
{% set _loading = 'eager' %}
{% endif %}
{% if _classes != null %}
{% set _classes = ' ' ~ _classes %}
{% endif %}
{% if _modifiers != null %}
{% set _classes = ' ' ~ _modifiers ~ ' ' ~ _classes %}
{% endif %}
{# ---------------------------------------- #}
<{{_tag}} class="c-image{{ _classes }}" {{_attr}}>
<div
class="c-image_inner"
{% if has_parallax %}
data-scroll
data-scroll-speed="{{ _parallax_speed }}"
{% endif %}
>
<img
class="c-image_img"
src="{{ _src }}"
alt="{{ _alt }}"
width="{{ _width }}"
height="{{ _height }}"
loading="{{ _loading }}"
onload="this.closest('.c-image')?.classList?.add('is-loaded');"
>
</div>
{% if _caption %}
{% if _is_figure %}
<figcaption class="c-image_description">{{ _caption }}</figcaption>
{% else %}
<div class="c-image_description"><span>{{ _caption }}</span></div>
{% endif %}
{% endif %}
</{{ _tag }}>

View File

@@ -7,6 +7,10 @@ title: Home
{% block content %}
<div class="o-container">
{# ====================== #}
{# ====== Headings ====== #}
{# ====================== #}
<h1 class="c-heading -h1">Heading 1</h1>
<h1 class="c-heading -h2">Heading 2</h1>
<h1 class="c-heading -h3">Heading 3</h1>
@@ -16,13 +20,19 @@ title: Home
<hr>
{# ======================= #}
{# ======== Texts ======== #}
{# ======================= #}
<p class="c-text -body-regular" style="max-width: 500px">
Lorem ipsum dolor sit amet consectetur adipisicing elit. Totam libero, sit pariatur voluptatum amet magni odio ducimus! Saepe facere iste porro voluptatem. Tenetur perferendis ea a quasi vitae! Ullam, blanditiis.
</p>
<hr>
<p class="c-text -body-regular">Buttons</p>
{# ======================= #}
{# ======= Buttons ======= #}
{# ======================= #}
{% include "@snippets/button.twig" with {
label: 'Button'
@@ -30,5 +40,15 @@ title: Home
<hr>
{# ====================== #}
{# ======= Images ======= #}
{# ====================== #}
{% include "@snippets/image.twig" with {
src: 'http://picsum.photos/800/600?v=1',
width: 800,
height: 600
} %}
</div>
{% endblock %}