Modelo SPA spa-blueprint

Para permitir que el autor utilice el Editor de SPA de AEM para editar el contenido de una SPA, existen requisitos que la SPA debe cumplir y que se describen en este documento.

Introducción introduction

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

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 no basadas en marcos: la PageModelManager y la ComponentMapping.

PageModelManager pagemodelmanager

La biblioteca PageModelManager se proporciona como un paquete NPM para su uso en un proyecto SPA. Acompaña al SPA y sirve como administrador del modelo de datos.

En nombre de la SPA, abstrae la recuperación y administración de la estructura JSON que representa la estructura de contenido real. También es responsable de la sincronización con la SPA para informarle cuando tenga que volver a procesar sus componentes.

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

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

ComponentMapping componentmapping

El módulo ComponentMapping se proporciona como paquete NPM al proyecto front-end. Almacena componentes front-end y proporciona una forma para que la SPA asigne componentes front-end a tipos de recursos de AEM. Esto permite una resolución dinámica de 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 de AEM. Cuando se monta, el componente front-end puede representarse a sí mismo utilizando el fragmento de modelo que ha recibido de las bibliotecas subyacentes.

Asignación de modelos dinámicos a componentes dynamic-model-to-component-mapping

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

Capa específica del marco de trabajo framework-specific-layer

Se debe implementar una tercera capa para cada módulo 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 intermediario y aspira a ser independiente del marco. Respetando los siguientes requisitos, se puede proporcionar una capa específica del marco de trabajo para que los componentes del proyecto interactúen con las bibliotecas subyacentes a cargo de la administración del modelo de datos.

Conceptos generales general-concepts

Modelo de página page-model

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 componentes de SPA. Los desarrolladores de SPA crean componentes de SPA que asignan a componentes de AEM. Para ello, utilizan el tipo de recurso (o la ruta al componente de AEM) como clave única.

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

Metadatos de campos meta-fields

El modelo de página utiliza el Exportador de modelos JSON, que a su vez se basa en la API Sling Model. Los modelos de sling exportables exponen la siguiente lista de campos para permitir que las bibliotecas subyacentes interpreten el modelo de datos:

Consulte también Introducción a AEM Content Services.

Módulo específico del marco de trabajo framework-specific-module

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

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

Implementaciones implementations

React react

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

Angular angular

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

Servicios y componentes principales main-services-and-components

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 deben proporcionarse las funcionalidades descritas.

El proveedor de modelos the-model-provider

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

Para ello, el proveedor de modelos debe registrarse en [PageModelManager](https://experienceleague.adobe.com/docs/experience-manager-65-lts/content/implementing/developing/spas/spa-blueprint.html?lang=es#pagemodelmanager). A continuación, cuando se produce un cambio, recibe y pasa los datos actualizados al componente que delega. De forma predeterminada, la propiedad disponible para el componente de delegación que llevará el fragmento del modelo se denomina cqModel. La implementación es libre de proporcionar esta propiedad al componente, pero debe tener en cuenta aspectos como la integración con la arquitectura del marco de trabajo, la capacidad de detección y la facilidad de uso.

El componente HTML Decorator the-component-html-decorator

El decorador de componentes es responsable de decorar la HTML externa del elemento de cada instancia de componente con una serie de atributos de datos y nombres de clase esperados por el editor de páginas.

Declaración de componente component-declaration

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

Declaración de capacidad de edición y marcador de posición editing-capability-declaration-and-placeholder

Los siguientes metadatos y nombres de clase deben agregarse al elemento HTML externo producido por el componente del proyecto. Permiten al editor de páginas ofrecer funcionalidades relacionadas.

Marcador de posición para componentes vacíos

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

Acerca del vacío de un componente

Contenedor container

Un contenedor es un componente diseñado para contener y procesar componentes secundarios. Para ello, el contenedor se repite en 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 amplía el componente secundario con las capacidades del proveedor de modelos y, finalmente, crea una instancia de él.

Página page

El componente Page amplía el componente Container. Un contenedor es un componente diseñado para contener y procesar componentes secundarios, incluidas páginas secundarias. Para ello, el contenedor repite 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. Page es responsable de crear instancias de componentes secundarios.

Cuadrícula adaptable responsive-grid

El componente Cuadrícula interactiva es un contenedor. Contiene una variante específica del proveedor de modelos que representa sus columnas. La cuadrícula adaptable 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 estar preasignado a su homólogo de AEM, ya que este componente es complejo y rara vez se personaliza.

Campos de modelo específicos specific-model-fields

Marcador de posición de la cuadrícula adaptable placeholder-of-the-reponsive-grid

El componente SPA está asignado 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 de la SPA, ese contenido se incrusta en el editor mediante un iframe y el atributo data-cq-editor se agrega al nodo del 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"/>

Asignación de componentes component-mapping

La biblioteca Component Mapping subyacente y su función MapTo se pueden encapsular y ampliar 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 de proyecto se amplía con la funcionalidad vacía antes de que se registre realmente en el almacén Component Mapping. Esto se hace encapsulando y ampliando la biblioteca ComponentMapping para introducir la compatibilidad del 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 contract-with-the-page-editor

Los componentes del proyecto deben generar como mínimo los siguientes atributos de datos para permitir que el editor interactúe con ellos.

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

Estructura típica de los elementos HTML typical-html-element-structure

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

<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>

Navegación y enrutamiento navigation-and-routing

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

La biblioteca PageModelManager subyacente y su módulo [ModelRouter](https://experienceleague.adobe.com/docs/experience-manager-65-lts/content/implementing/developing/spas/spa-routing.html?lang=es) (habilitado de forma predeterminada) son responsables de la recuperación previa y de proporcionar acceso al modelo asociado con una ruta de recurso determinada.

Las dos entidades están relacionadas con la noción de enrutamiento, pero [ModelRouter](https://experienceleague.adobe.com/docs/experience-manager-65-lts/content/implementing/developing/spas/spa-routing.html?lang=es) solo es responsable de que [PageModelManager](https://experienceleague.adobe.com/docs/experience-manager-65-lts/content/implementing/developing/spas/spa-blueprint.html?lang=es#pagemodelmanager) se cargue con un modelo de datos estructurado en sincronización con el estado de la aplicación actual.

Consulte el artículo Enrutamiento de modelo SPA para obtener más información.

SPA en acción spa-in-action

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

Lectura adicional further-reading

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