Modelo SPA

Para permitir que el autor utilice el AEM SPA Editor para editar el contenido de un SPA, hay requisitos que el SPA debe cumplir, que se describen en este documento.

NOTA

La función Editor de aplicaciones de una sola página (SPA) requiere AEM 6.4 service pack 2 o posterior.

El Editor de SPA es la solución recomendada para proyectos que requieren SPA procesamiento del lado del cliente basado en el marco de trabajo (por ejemplo, React o Angular).

Introducción

Este documento describe el contrato general que cualquier marco de SPA debe cumplir (es decir, el tipo de capa de soporte AEM) para implementar componentes SPA editables dentro de AEM.

NOTA

Los siguientes requisitos son independientes del marco de trabajo. Si se cumplen estos requisitos, se puede proporcionar una capa específica del marco compuesta por módulos, componentes y servicios.

Estos requisitos ya se cumplen para los marcos React y Angular de AEM. Los requisitos de este modelo solo son relevantes si desea implementar otro marco para utilizarlo con AEM.

ATENCIÓN

Aunque las capacidades SPA de AEM son independientes del marco, actualmente solo se admiten los marcos React y Angular.

Para permitir que el autor utilice el Editor de páginas de AEM para editar los datos expuestos por un marco de aplicación de una sola página, un proyecto debe poder interpretar la estructura del modelo que representa la semántica de los datos almacenados para una aplicación dentro del repositorio de AEM. Para lograr este objetivo, se proporcionan dos bibliotecas independientes del marco de trabajo: el PageModelManager y el ComponentMapping.

PageModelManager

La biblioteca PageModelManager se proporciona como un paquete NPM que un proyecto SPA utilizará. Acompaña al SPA y sirve como administrador de modelos de datos.

En nombre del SPA, abstrae la recuperación y administración de la estructura JSON que representa la estructura de contenido real. También se encarga de sincronizar con el SPA para informarle de cuándo tiene que volver a procesar sus componentes.

Consulte el paquete NPM @adobe/aem-spa-page-model-manager

Al inicializar PageModelManager, la biblioteca carga primero el modelo raíz proporcionado de la aplicación (mediante parámetro, meta propiedad o dirección URL actual). Si la biblioteca identifica que el modelo de la página actual no forma parte del modelo raíz que obtiene e incluye como modelo de una página secundaria.

page_model_grouping

Asignación de componentes

El módulo ComponentMapping se proporciona como paquete NPM al proyecto front-end. Almacena componentes front-end y proporciona una forma para que el SPA asigne componentes front-end a AEM tipos de recursos. Esto permite una resolución dinámica de los componentes al analizar el modelo JSON de la aplicación.

Cada elemento presente en el modelo contiene un campo :type que expone un tipo de recurso AEM. Cuando se monta, el componente frontal puede procesarse utilizando el fragmento de modelo que ha recibido de las bibliotecas subyacentes.

Asignación dinámica de modelos a componentes

Para obtener más información sobre cómo se produce la asignación de modelos dinámicos a componentes en el SDK de SPA de Javascript para AEM, consulte el artículo Asignación de modelos dinámicos a componentes para SPA.

Capa específica de marco

Se debe implementar una tercera capa para cada marco front-end. Esta tercera biblioteca es responsable de interactuar con las bibliotecas subyacentes y proporciona una serie de puntos de entrada bien integrados y fáciles de usar para interactuar con el modelo de datos.

El resto de este documento describe los requisitos de esta capa específica del marco intermedio y aspira a ser independiente del marco. Respetando los siguientes requisitos, se puede proporcionar una capa específica del marco para que los componentes del proyecto interactúen con las bibliotecas subyacentes encargadas de administrar el modelo de datos.

Conceptos generales

Modelo de página

La estructura de contenido de la página se almacena en AEM. El modelo de la página se utiliza para asignar y crear instancias de SPA componentes. Los SPA desarrolladores crean SPA componentes que asignan a AEM componentes. Para ello, utilizan el tipo de recurso (o ruta al componente AEM) como clave única.

Los componentes SPA deben estar sincronizados con el modelo de página y actualizarse con los cambios correspondientes en su contenido. Se debe utilizar un patrón que aproveche los componentes dinámicos para crear instancias de los componentes sobre la marcha siguiendo la estructura del modelo de página proporcionada.

Meta Fields

El modelo de página aprovecha el exportador de modelo JSON, que se basa en la API del modelo de Sling. Los modelos de Sling exportables exponen la siguiente lista de campos para permitir que las bibliotecas subyacentes interpreten el modelo de datos:

  • :type: Tipo del recurso AEM (predeterminado = tipo de recurso)

  • :children: Secciones jerárquicas del recurso actual. Los elementos secundarios no forman parte del contenido interno del recurso actual (se pueden encontrar en elementos que representan una página)

  • :hierarchyType: Tipo jerárquico de un recurso. El PageModelManager admite actualmente el tipo de página

  • :items: Recursos de contenido secundario del recurso actual (estructura anidada, solo presente en contenedores)

  • :itemsOrder: Lista ordenada de los niños. El objeto de mapa JSON no garantiza el orden de sus campos. Al tener el mapa y la matriz actual, el consumidor de la API tiene las ventajas de ambas estructuras

  • :path: Ruta de contenido de un elemento (presente en elementos que representan una página)

Consulte también Introducción a los servicios de contenido AEM.

Módulo específico del marco

La separación de las preocupaciones ayuda a facilitar la ejecución del proyecto. Por lo tanto, se debe proporcionar un paquete específico de npm. Este paquete es responsable de agregar y exponer los módulos base, servicios y componentes. Estos componentes deben encapsular la lógica de administración del modelo de datos y proporcionar acceso a los datos que el componente del proyecto espera. El módulo también es responsable de la exposición transitoria de puntos de entrada útiles de las bibliotecas subyacentes.

Para facilitar la interoperabilidad de las bibliotecas, el Adobe aconseja al módulo específico de la infraestructura que agrupe las siguientes bibliotecas. Si es necesario, la capa puede encapsular y adaptar las API subyacentes antes de exponerlas al proyecto.

Implementaciones

React

módulo npm: @adobe/aem-react-editable-components

Angular

módulo npm: próximamente

Servicios principales y componentes

Las siguientes entidades deben aplicarse de conformidad con las directrices específicas de cada marco. En función de la arquitectura del marco, la implementación puede variar ampliamente, pero se deben proporcionar las funcionalidades descritas.

El proveedor de modelos

Los componentes de proyecto deben delegar el acceso a los fragmentos de un modelo a un proveedor de modelos. A continuación, el proveedor de modelos se encarga de escuchar los cambios realizados en el fragmento especificado del modelo y devolver el modelo actualizado al componente delegado.

Para ello, el proveedor de modelos debe registrarse en el PageModelManager. A continuación, cuando se produce un cambio, recibe y pasa los datos actualizados al componente de delegación. Por convención, la propiedad que se pone a disposición del componente delegado que llevará el fragmento del modelo se llama cqModel. La implementación puede proporcionar esta propiedad al componente, pero debe tener en cuenta aspectos como la integración con la arquitectura del marco, la capacidad de detección y la facilidad de uso.

El Decorador HTML de componente

El decorador de componentes es responsable de decorar el HTML exterior del elemento de cada instancia de componente con una serie de atributos de datos y nombres de clase que el editor de páginas espera.

Declaración de componentes

Los siguientes metadatos deben agregarse al elemento HTML externo producido por el componente del proyecto. Permiten al Editor de páginas recuperar la configuración de edición correspondiente.

  • data-cq-data-path: Ruta al recurso en relación con el jcr:content

Declaración de capacidad de edición y marcador de posición

Los siguientes metadatos y nombres de clase deben agregarse al elemento HTML externo producido por el componente del proyecto. Permiten que el Editor de páginas ofrezca funciones relacionadas.

  • cq-placeholder: Nombre de clase que identifica el marcador de posición de un componente vacío
  • data-emptytext: Etiqueta que mostrará la superposición cuando una instancia de componente esté vacía

Marcador de posición para componentes vacíos

Cada componente debe ampliarse con una funcionalidad que decore el elemento HTML exterior con atributos de datos y nombres de clase específicos de marcadores de posición y superposiciones relacionadas cuando el componente se identifica como vacío.

Acerca del vacío de un componente

  • ¿El componente está vacío lógicamente?
  • ¿Cuál debe ser la etiqueta que muestra la superposición cuando el componente está vacío?

Contenedor

Un contenedor es un componente diseñado para contener y procesar componentes secundarios. Para ello, el contenedor se repite sobre las propiedades :itemsOrder, :items y :children de su modelo.

El contenedor obtiene dinámicamente los componentes secundarios del almacén de la biblioteca ComponentMapping. A continuación, el contenedor extiende el componente secundario con las capacidades del proveedor de modelo y, finalmente, lo crea una instancia.

Página

El componente Page extiende el componente Container. Un contenedor es un componente diseñado para contener y procesar componentes secundarios, incluidas páginas secundarias. Para ello, el contenedor se repite sobre las propiedades :itemsOrder, :items y :children de su modelo. El componente Page obtiene dinámicamente los componentes secundarios del almacén de la biblioteca ComponentMapping. El Page es responsable de crear instancias de componentes secundarios.

Cuadrícula interactiva

El componente Cuadrícula interactiva es un contenedor. Contiene una variante específica del proveedor de modelos que representa sus columnas. La cuadrícula interactiva y sus columnas son responsables de decorar el elemento HTML exterior del componente del proyecto con los nombres de clase específicos contenidos en el modelo.

El componente Cuadrícula interactiva debe asignarse previamente a su homólogo AEM, ya que este componente es complejo y rara vez se personaliza.

Campos de modelo específicos

  • gridClassNames: Nombres de clase proporcionados para la cuadrícula adaptable
  • columnClassNames: Nombres de clase proporcionados para la columna adaptable

Consulte también el recurso npm @adobe/aem-react-editable-components#srccomponentsresponsivegridjsx

Marcador de posición de la cuadrícula interactiva

El componente SPA se asigna a un contenedor gráfico como la cuadrícula interactiva y debe agregar un marcador de posición secundario virtual cuando se crea el contenido. Cuando el Editor de páginas crea el contenido del SPA, este se incrusta en el editor mediante un iframe y el atributo data-cq-editor se agrega al nodo de documento de ese contenido. Cuando el atributo data-cq-editor está presente, el contenedor debe incluir un elemento HTML para representar el área con la que el autor interactúa al insertar un nuevo componente en la página.

Por ejemplo:

<div data-cq-data-path={"path/to/the/responsivegrid/*"} className="new section aem-Grid-newComponent"/>
NOTA

El editor de páginas requiere actualmente los nombres de clase utilizados en el ejemplo.

  • "new section": Indica que el elemento actual es el marcador de posición del contenedor
  • "aem-Grid-newComponent": Normaliza el componente para la creación del diseño

Asignación de componentes

La biblioteca Component Mapping subyacente y su función MapTo pueden encapsularse y ampliarse para proporcionar las funcionalidades relativas a la configuración de edición proporcionada junto con la clase de componente actual.

const EditConfig = {
 
    emptyLabel: 'My Component',
 
    isEmpty: function() {
        return !this.props || !this.props.cqModel || this.props.cqModel.isEmpty;
    }
};
 
class MyComponent extends Component {
 
    render() {
        return <div className={'my-component'}></div>;
    }
}
 
MapTo('component/resource/path')(MyComponent, EditConfig);

En la implementación anterior, el componente del proyecto se amplía con la funcionalidad de vacío antes de registrarse en el almacén Asignación de componentes. Esto se realiza encapsulando y ampliando la biblioteca ComponentMapping para presentar la compatibilidad con el objeto de configuración EditConfig:

/**
 * Configuration object in charge of providing the necessary data expected by the page editor to initiate the authoring. The provided data will be decorating the associated component
 *
 * @typedef {{}} EditConfig
 * @property {String} [dragDropName]       If defined, adds a specific class name enabling the drag and drop functionality
 * @property {String} emptyLabel           Label to be displayed by the placeholder when the component is empty. Optionally returns an empty text value
 * @property {function} isEmpty            Should the component be considered empty. The function is called using the context of the wrapper component giving you access to the component model
 */
 
/**
 * Map a React component with the given resource types. If an {@link EditConfig} is provided the <i>clazz</i> is wrapped to provide edition capabilities on the AEM Page Editor
 *
 * @param {string[]} resourceTypes                      - List of resource types for which to use the given <i>clazz</i>
 * @param {class} clazz                                 - Class to be instantiated for the given resource types
 * @param {EditConfig} [editConfig]                     - Configuration object for enabling the edition capabilities
 * @returns {class}                                     - The resulting decorated Class
 */
ComponentMapping.map = function map (resourceTypes, clazz, editConfig) {};

Contrato con el Editor de páginas

Los componentes del proyecto deben generar como mínimo los siguientes atributos de datos para que el editor pueda interactuar con ellos.

  • data-cq-data-path: Ruta relativa del componente proporcionada por el PageModel (por ejemplo, "root/responsivegrid/image"). Este atributo no debe agregarse a las páginas.

En resumen, para que el editor de páginas lo interprete como editable, un componente de proyecto debe respetar el siguiente contrato:

  • Proporcione los atributos esperados para asociar una instancia de componente front-end a un recurso AEM.
  • Proporcione la serie esperada de atributos y nombres de clase que permitan la creación de marcadores de posición vacíos.
  • Proporcione los nombres de clase esperados que permitan arrastrar y soltar recursos.

Estructura de elementos HTML típica

El siguiente fragmento ilustra la representación HTML típica de una estructura de contenido de página. Estos son algunos puntos importantes:

  • El elemento de cuadrícula adaptable lleva nombres de clase con el prefijo aem-Grid--
  • El elemento de columna interactivo lleva nombres de clase con el prefijo aem-GridColumn--
  • Una cuadrícula adaptable que también es la columna de una cuadrícula principal está ajustada, como que los dos prefijos anteriores no aparecen en el mismo elemento
  • Los elementos correspondientes a recursos editables llevan una propiedad data-cq-data-path. Consulte la sección Contrato con el Editor de páginas de este documento.
<div data-cq-data-path="/content/page">
    <div class="aem-Grid aem-Grid--12 aem-Grid--default--12">
        <div class="aem-container aem-GridColumn aem-GridColumn--default--12" data-cq-data-path="/content/page/jcr:content/root/responsivegrid">
            <div class="aem-Grid aem-Grid--12 aem-Grid--default--12">
                <div class="cmp-image cq-dd-image aem-GridColumn aem-GridColumn--default--12" data-cq-data-path="/root/responsivegrid/image">
                    <img src="/content/we-retail-spa-sample/react/jcr%3acontent/root/responsivegrid/image.img.jpeg/1512113734019.jpeg">
                </div>
            </div>
        </div>
    </div>
</div>

La aplicación es propietaria del enrutamiento. El desarrollador de front-end primero debe implementar un componente de navegación (asignado a un componente de navegación de AEM). Este componente renderizaría los vínculos URL para utilizarlos junto con una serie de rutas que mostrarán u ocultarán fragmentos de contenido.

La biblioteca PageModelManager subyacente y su módulo ModelRouter (habilitado de forma predeterminada) son responsables de la recuperación previa y el acceso al modelo asociado a una ruta de recurso determinada.

Las dos entidades están relacionadas con la noción de enrutamiento, pero el ModelRouter solo es responsable de que el PageModelManager se cargue con un modelo de datos estructurado en sincronización con el estado de la aplicación actual.

Consulte el artículo SPA Model Routing para obtener más información.

SPA en acción

Vea cómo funciona una SPA sencilla y experimente con un SPA usted mismo continuando con el documento Introducción a la SPA en AEM.

Lectura adicional

Para obtener más información sobre SPA en AEM, consulte los siguientes documentos:

En esta página