Uso de componentes principales

Para ponerse en marcha con los componentes principales de su propio proyecto, hay cuatro pasos que se detallan individualmente en las secciones siguientes:

  1. Descargar e instalar
  2. Crear componentes proxy
  3. Cargar los estilos principales
  4. Habilitar los componentes
CONSEJO

Para obtener instrucciones más amplias sobre cómo empezar desde cero con la configuración del proyecto, los componentes principales, las plantillas editables, las bibliotecas de clientes y el desarrollo de componentes, el siguiente tutorial de varias partes puede ser de interés:
Introducción a AEM Sites: Tutorial de WKND

CONSEJO

Si utiliza el AEM tipo de archivo del proyecto, los componentes principales se incluyen automáticamente en el proyecto en función de las recomendaciones de prácticas recomendadas de Adobe.

Descargar e instalar

Una de las ideas que impulsan los componentes principales es la flexibilidad. La publicación de nuevas versiones de los componentes principales con más frecuencia permite que el Adobe sea más flexible a la hora de ofrecer nuevas funciones. A su vez, los desarrolladores pueden ser flexibles en qué componentes eligen integrar en sus proyectos y con qué frecuencia desean actualizarlos. Esto resulta en un proceso de versión independiente tanto para los componentes principales como para los AEM.

Por lo tanto, si está ejecutando AEM as a Cloud Service o local determina los pasos de instalación.

AEM as a Cloud Service

¡No hay paso uno! AEM como Cloud Service viene automáticamente con la última versión de los componentes principales. Al igual que AEMaaCS le ofrece las últimas funciones de AEM, AEMaaCS le mantiene actualizado automáticamente con la última versión de los componentes principales.

Algunos puntos que se deben tener en cuenta al utilizar los componentes principales en AEMaaCS:

  • Los componentes principales se incluyen en /libs.
  • La canalización de generación de proyectos generará advertencias en el registro si vuelve a incluir los componentes principales como parte de /apps e ignorará la versión incrustada como parte del proyecto.
    • En una próxima versión, volver a incluir los componentes principales producirá un error en la compilación de la canalización.
  • Si el proyecto anteriormente incluía los componentes principales en /apps, es posible que tenga que ajustar el proyecto.
  • Aunque los componentes principales se encuentran ahora en /libs, no se recomienda crear ninguna superposición de la misma ruta en /apps. En su lugar, se debe utilizar el patrón de componentes proxy si es necesario personalizar cualquier aspecto de los componentes.

AEM 6.5 y anterior

Los componentes principales no forman parte del inicio rápido al iniciarse en el modo de producción (sin contenido de muestra). Por lo tanto, el primer paso es descargar el último paquete de contenido publicado desde GitHub e instalarlo en sus entornos AEM.

Existen varias formas de automatizar esto, pero la forma más sencilla de instalar rápidamente un paquete de contenido en una instancia es mediante el uso del Administrador de paquetes; consulte Instalar paquetes. Además, una vez que tenga una instancia de publicación en ejecución también, deberá replicar ese paquete al editor; consulte Duplicación de paquetes.

Crear componentes proxy

Por los motivos explicados en la sección Patrón de componente proxy, no se debe hacer referencia directamente a los componentes principales desde el contenido. Para evitarlo, todos pertenecen a un grupo de componentes ocultos ( .core-wcm o .core-wcm-form), lo que impide que se muestren directamente en el editor.

En su lugar, se deben crear componentes específicos del sitio, que definan el nombre y el grupo del componente deseado para mostrarlos a los autores de la página y hacen referencia a cada componente principal como su supertipo. Estos componentes específicos del sitio a veces se denominan "componentes proxy", ya que no necesitan contener nada y sirven principalmente para definir la versión de un componente que se utilizará para el sitio. Sin embargo, al personalizar los Componentes principales, estos componentes proxy desempeñan un papel esencial para el marcado y la personalización lógica.

Por lo tanto, para cada componente principal que se desee utilizar en un sitio, debe:

  1. Cree un componente proxy correspondiente en la carpeta de componentes del sitio.


    EjemploEn /apps/my-site/components crear un nodo de título de tipo cq:Component

  2. Seleccione la versión del componente principal correspondiente con el supertipo .


    EjemploAgregar la siguiente propiedad:
    sling:resourceSuperType="core/wcm/components/title/v1/title"

  3. Defina el grupo, el título y, opcionalmente, la descripción del componente. Estos valores son específicos del proyecto y dictan cómo se expone el componente a los autores.


    EjemploAñadir las siguientes propiedades:

    componentGroup="My Site"
    jcr:title="Title"  
    jcr:description="Section Heading"
    

Por ejemplo, observe el componente title del sitio WKND, que es un buen ejemplo de un componente proxy creado de esa manera.

Cargar los estilos principales

  1. Si aún no lo ha hecho, cree una Biblioteca de clientes que contenga todos los archivos CSS y JS necesarios para su sitio.

  2. En la biblioteca de cliente de su sitio, agregue las dependencias a los componentes principales que puedan ser necesarias. Esto se hace añadiendo una propiedad embed.

    Por ejemplo, para incluir las bibliotecas de cliente de todos los componentes principales v1, la propiedad que se agregaría sería:

    embed="[  
    core.wcm.components.image.v1,  
    core.wcm.components.list.v1,  
    core.wcm.components.breadcrumb.v1,  
    core.wcm.components.form.container.v1,  
    core.wcm.components.form.text.v1  
    ]"
    

Asegúrese de que los componentes proxy y las bibliotecas de cliente se hayan implementado en el entorno de AEM antes de pasar a la siguiente sección.

Permitir los componentes

Los siguientes pasos se realizan en el Editor de plantillas.

  1. En el Editor de plantillas, seleccione el contenedor de diseño y abra su política.
  2. En la lista de componentes permitidos, seleccione los componentes proxy creados anteriormente, que deberían aparecer en el grupo de componentes asignado a ellos. Una vez finalizado, aplique los cambios.
  3. De forma opcional, para los componentes que tienen un cuadro de diálogo de diseño, se pueden preconfigurar.

¡Eso es todo! En las páginas creadas a partir de la plantilla editada, ahora debería poder utilizar los componentes recién creados.

Consulte lo siguiente:

En esta página