Imágenes optimizadas con AEM Headless images-with-aem-headless

Las imágenes son un aspecto crítico de desarrollar experiencias sin encabezado de AEM enriquecidas y convincentes. AEM Headless admite la administración de recursos de imagen y su entrega optimizada.

Los fragmentos de contenido utilizados en el modelado de contenido sin encabezado de AEM suelen hacer referencia a recursos de imagen destinados a su visualización en la experiencia sin encabezado. Las consultas GraphQL de AEM se pueden escribir para proporcionar direcciones URL a imágenes en función de desde dónde se hace referencia a la imagen.

El tipo ImageRef tiene cuatro opciones de URL para las referencias de contenido:

_dynamicUrl es la dirección URL recomendada que se debe usar para la entrega de recursos de imagen y debe reemplazar el uso de _path, _authorUrl y _publishUrl siempre que sea posible.

Modelo de fragmento de contenido

Asegúrese de que el campo Fragmento de contenido que contiene la referencia de imagen sea del tipo de datos referencia de contenido.

Los tipos de campo se revisan en el Modelo de fragmento de contenido, seleccionando el campo e inspeccionando la pestaña Propiedades a la derecha.

Consulta persistente de GraphQL

En la consulta de GraphQL, devuelva el campo como tipo ImageRef y solicite el campo _dynamicUrl. Por ejemplo, consultar una aventura en el proyecto del sitio WKND e incluir la URL de imagen para las referencias del recurso de imagen en su campo primaryImage, se puede hacer con una nueva consulta persistente wknd-shared/adventure-image-by-path definida como:

query($path: String!, $imageFormat: AssetTransformFormat=JPG, $imageSeoName: String, $imageWidth: Int, $imageQuality: Int) {
  adventureByPath(
    _path: $path
    _assetTransform: {
      format: $imageFormat
      width: $imageWidth
      quality: $imageQuality
      preferWebp: true
    }
  ) {
    item {
      _path
      title
      primaryImage {
        ... on ImageRef {
          _dynamicUrl
        }
      }
    }
  }
}

Variables de consulta

{
  "path": "/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp",
  "imageFormat": "JPG",
  "imageWidth": 1000,
}

La variable $path utilizada en el filtro _path requiere la ruta de acceso completa al fragmento de contenido (por ejemplo, /content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp).

El _assetTransform define cómo se construye el _dynamicUrl para optimizar la representación de la imagen servida. Las direcciones URL de imágenes optimizadas para la web también se pueden ajustar en el cliente cambiando los parámetros de consulta de la dirección URL.

Respuesta de GraphQL

La respuesta JSON resultante contiene los campos solicitados que contienen la URL optimizada para la web a los recursos de imagen.

{
  "data": {
    "adventureByPath": {
      "item": {
        "_path": "/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp",
        "title": "Bali Surf Camp",
        "primaryImage": {
          "_dynamicUrl": "/adobe/dynamicmedia/deliver/dm-aid--a38886f7-4537-4791-aa20-3f6ef0ac3fcd/adobestock_175749320.jpg?preferwebp=true&width=1000&quality=80"
        }
      }
    }
  }
}

Para cargar la imagen optimizada para la web de la imagen a la que se hace referencia en su aplicación, utilizó _dynamicUrl de primaryImage como dirección URL de origen de la imagen.

En React, la visualización de una imagen optimizada para la web desde AEM Publish tiene este aspecto:

// The AEM host is usually read from a environment variable of the SPA.
const AEM_HOST = "https://publish-p123-e456.adobeaemcloud.com";
...
let dynamicUrl = AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl;
...
<img src={dynamicUrl} alt={data.adventureByPath.item.title}/>

Recuerde que _dynamicUrl no incluye el dominio de AEM, por lo que debe proporcionar el origen deseado para que se resuelva la dirección URL de la imagen.

URL interactivas

El ejemplo anterior muestra el uso de una imagen de un solo tamaño, pero en las experiencias web, a menudo se requieren conjuntos de imágenes adaptables. Las imágenes interactivas se pueden implementar con img srcsets o elementos de imagen. El siguiente fragmento de código muestra cómo utilizar _dynamicUrl como base. width es un parámetro de URL que puede anexar a _dynamicUrl para activar distintas vistas adaptables.

// The AEM host is usually read from a environment variable of the SPA.
const AEM_HOST = "https://publish-p123-e456.adobeaemcloud.com";
...
// Read the data from GraphQL response
let dynamicUrl = AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl;
let alt = data.adventureByPath.item.title;
...
{/*-- Example img srcset --*/}
document.body.innerHTML=`<img>
    alt="${alt}"
    src="${dynamicUrl}&width=1000}"
    srcset="`
      ${dynamicUrl}&width=1000 1000w,
      ${dynamicUrl}&width=1600 1600w,
      ${dynamicUrl}&width=2000 2000w,
      `"
    sizes="calc(100vw - 10rem)"/>`;
...
{/*-- Example picture --*/}
document.body.innerHTML=`<picture>
      <source srcset="${dynamicUrl}&width=2600" media="(min-width: 2001px)"/>
      <source srcset="${dynamicUrl}&width=2000" media="(min-width: 1000px)"/>
      <img src="${dynamicUrl}&width=400" alt="${alt}"/>
    </picture>`;

Ejemplo de React

Vamos a crear una aplicación React simple que muestre imágenes optimizadas para la web siguiendo patrones de imagen adaptables. Existen dos patrones principales para las imágenes adaptables:

Elemento img con srcset

Los elementos Img con srcset se utilizan con el atributo sizes para proporcionar recursos de imagen diferentes para tamaños de pantalla diferentes. Los flujos de imagen son útiles al proporcionar diferentes recursos de imagen para diferentes tamaños de pantalla.

Elemento de imagen

Los elementos de imagen se utilizan con varios elementos source para proporcionar diferentes recursos de imagen para diferentes tamaños de pantalla. Los elementos de imagen son útiles al proporcionar diferentes representaciones de imagen para diferentes tamaños de pantalla.

Código de ejemplo

Esta sencilla aplicación React usa AEM Headless SDK para consultar las API de AEM Headless en busca de contenido de Adventure y muestra la imagen optimizada para la web usando elemento img con srcset y elemento picture. srcset y sources utilizan una función setParams personalizada para anexar el parámetro de consulta de entrega optimizado para la web a _dynamicUrl de la imagen, de modo que se debe cambiar la representación de la imagen entregada según las necesidades del cliente web.

La consulta de AEM se realiza en el vínculo personalizado de React useAdventureByPath que usa AEM Headless SDK.

// src/App.js

import "./App.css";
import { useAdventureByPath } from './api/persistedQueries'

const AEM_HOST = process.env.AEM_HOST;

function App() {

  /**
   * Update the dynamic URL with client-specific query parameters
   * @param {*} imageUrl the image URL
   * @param {*} params the AEM web-optimized image query parameters
   * @returns the dynamic URL with the query parameters
   */
  function setOptimizedImageUrlParams(imageUrl, params) {
    let url = new URL(imageUrl);
    Object.keys(params).forEach(key => {
      url.searchParams.set(key, params[key]);
    });
    return url.toString();
  }

  // Get data from AEM using GraphQL persisted query as defined above
  // The details of defining a React useEffect hook are explored in How to > AEM Headless SDK
  // The 2nd parameter define the base GraphQL query parameters used to request the web-optimized image
  let { data, error } = useAdventureByPath(
        "/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp",
        { imageFormat: "JPG" }
      );

  // Wait for AEM Headless APIs to provide data
  if (!data) { return <></> }

  const alt = data.adventureByPath.item.title;
  const imageUrl =  AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl;

  return (
    <div className="app">

      <h1>Web-optimized images</h1>

      {/* Render the web-optimized image img with srcset for the Adventure Primary Image */}
      <h2>Img srcset</h2>

      <img
        alt={alt}
        src={setOptimizedImageUrlParams(imageUrl, { width: 1000 })}
        srcSet={
            `${setOptimizedImageUrlParams(imageUrl, { width: 1000 })} 1000w,
             ${setOptimizedImageUrlParams(imageUrl, { width: 1600 })} 1600w,
             ${setOptimizedImageUrlParams(imageUrl, { width: 2000 })} 2000w`
        }
        sizes="calc(100vw - 10rem)"/>

       {/* Render the web-optimized picture for the Adventure Primary Image */}
        <h2>Picture element</h2>

        <picture>
          {/* When viewport width is greater than 2001px */}
          <source srcSet={setOptimizedImageUrlParams(imageUrl, { width : 2600 })} media="(min-width: 2001px)"/>
          {/* When viewport width is between 1000px and 2000px */}
          <source srcSet={setOptimizedImageUrlParams(imageUrl, { width : 2000})} media="(min-width: 1000px)"/>
          {/* When viewport width is less than 799px */}
          <img src={setOptimizedImageUrlParams(imageUrl, { width : 400, crop: "550,300,400,400" })} alt={alt}/>
        </picture>
    </div>
  );
}

export default App;