Generate <img> markup block for an image.
Project description
A module to generate performant HTML image markup for images. The markup will:
Use data-src attributes for lazysizes
Use predefined srcset break points
Resize assets.ubuntu.com images with ?w=XX&h=XX query parameters
Prefix all image URLs with cloudinary proxy URLs, for CDN and image transformations
Parameters
url (mandatory string): The url to an image (e.g. https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png)
alt (mandatory string): Alt text to describe the image
width (mandatory integer): The number of pixels wide the image should be
height (mandatory integer): The number of pixels high the image should be
col (optional): The number of Vanilla columns the image should span (helps define break points efficiently)
attributes (optional): A dict of HTMLElement attributes
Usage
The image_template function can be used directly to generate image Markup.
from canonicalwebteam import image_template
image_markup = image_template(
url="https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png",
alt="Operational dashboard",
width="1040",
height="585",
attributes={}
)However, the most common usage is to add it to Django or Flask template contexts, as an image function.
Add lazysizes
The markup generated will use lazysizes format - it will use data-src instead of src and add the lazyload class.
Therefore to use this plugin you need to have lazysizes loaded on your pages. The simplest way to achieve this is to include this in your <head>:
<script src="https://assets.ubuntu.com/v1/842d27d3-lazysizes.min.js" async=""></script>Django usage
Add it as a template tag:
# myapp/templatetags.py
from canonicalwebteam import image_template
from django import template
from django.utils.safestring import mark_safe
register = template.Library()
@register.simple_tag
def image(*args, **kwargs):
return mark_safe(image_template(*args, **kwargs))
# settings.py
TEMPLATES[0]["OPTIONS"]["builtins"].append("myapp.templatetags")Use it in templates:
# templates/mytemplate.html
{% image url="https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png" alt="Operational dashboard" width="1040" height="585" %}Flask usage
Add it as a template tag:
# app.py
from canonicalwebteam import image_template
from flask import Flask
app = Flask(__name__)
@app.context_processor
def utility_processor():
return {"image": image_template}Use it in templates:
# templates/mytemplate.html
{{
image(
url="https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png",
alt="Operational dashboard",
width="1040",
height="585"
) | safe
}}Generated markup
All the above examples will generate the following markup:
<img
data-srcset="https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_412/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 460w
,https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_572/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 620w
,https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_720/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 767w
,https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_990/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 1030w"
data-src="https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585"
alt="Operational dashboard"
width="1040"
height="585"
class="lazyload"
/>
<noscript>
<img
srcset="https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_412/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 460w
,https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_572/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 620w
,https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_720/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 767w
,https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto,w_990/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585 1030w"
src="https://res.cloudinary.com/canonical/image/fetch/q_auto,f_auto/https://assets.ubuntu.com/v1/9f6916dd-k8s-prometheus-light.png?w=1040&h=585"
alt="Operational dashboard"
width="1040"
height="585"
/>
</noscript>Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for canonicalwebteam.image-template-0.2.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e96f5c443e71795d7b70f0a05b9f258e67ee334f0383b0b42193c0212a9caddd |
|
| MD5 | fb14260c02872001d9a7bb2fbc54296f |
|
| BLAKE2b-256 | a03cc34a6f8c7cd8a3a86ca41cb73c280af5e414c780b8e61f3c6757b1534246 |
