Guida di riferimento dei componenti

I componenti sono al centro della creazione di un’esperienza nell’AEM. Il Componenti core e Archetipo progetto AEM semplificate l'utilizzo di un set di strumenti con componenti robusti e pronti. Il Esercitazione WKND spiega allo sviluppatore come utilizzare questi strumenti e come creare componenti personalizzati per creare un nuovo sito AEM.

Poiché l’esercitazione WKND copre la maggior parte dei casi d’uso, questo documento è inteso solo come supplemento a tali risorse. Fornisce informazioni tecniche approfondite sulla struttura e la configurazione dei componenti in AEM e non intende essere una guida introduttiva.

Panoramica

Questa sezione descrive concetti e problemi chiave come introduzione ai dettagli necessari per lo sviluppo di componenti personalizzati.

Pianificazione

Prima di iniziare a configurare o codificare il componente, è necessario chiedere:

• Cosa devi fare esattamente con il nuovo componente?
• È necessario creare il componente da zero o è possibile ereditare le nozioni di base da un componente esistente?
• Il componente richiederà logica per selezionare/manipolare il contenuto?
  • La logica deve essere tenuta separata dal livello dell'interfaccia utente. HTL è progettato per garantire che questo accada.
• Il componente avrà bisogno della formattazione CSS?
  • La formattazione CSS deve essere mantenuta separata dalle definizioni dei componenti. Definisci le convenzioni per la denominazione degli elementi HTML in modo da poterli modificare tramite file CSS esterni.
• Quali implicazioni per la sicurezza può presentare il nuovo componente?

Riutilizzo dei componenti esistenti

Prima di dedicare tempo alla creazione di un componente completamente nuovo, è consigliabile personalizzare o estendere i componenti esistenti. Componenti core offre una suite di componenti flessibili, robusti e testati pronti per la produzione.

Estensione dei Componenti core

I Componenti core offrono anche cancella modelli di personalizzazione che puoi utilizzare per adattarle alle esigenze del tuo progetto.

Sovrapposizione di componenti

I componenti possono essere ridefiniti anche con sovrapposizione in base alla logica del percorso di ricerca. Tuttavia, in tal caso, Sling Resource Merger non verrà attivato e /apps deve definire l’intera sovrapposizione.

Estensione delle finestre di dialogo dei componenti

È inoltre possibile modificare la finestra di dialogo di un componente utilizzando Sling Resource Merger e definendo la proprietà sling:resourceSuperType.

Ciò significa che è sufficiente ridefinire le differenze richieste, anziché ridefinire l’intera finestra di dialogo.

Logica dei contenuti e markup di rendering

Il rendering del componente verrà eseguito con HTML. Il componente deve definire le HTML necessarie per acquisire il contenuto richiesto e quindi eseguirne il rendering come richiesto, sia nell’ambiente di authoring che in quello di pubblicazione.

Si consiglia di mantenere il codice responsabile del markup e del rendering separato dal codice che controlla la logica utilizzata per selezionare il contenuto del componente.

Questa filosofia è supportata da HTL: linguaggio per modelli appositamente limitato per garantire che venga utilizzato un linguaggio di programmazione reale per definire la logica di business sottostante. Questo meccanismo evidenzia il codice chiamato per una determinata vista e, se necessario, consente una logica specifica per diverse viste dello stesso componente.

Questa logica (facoltativa) può essere implementata in diversi modi e viene richiamata da HTL con comandi specifici:

• Utilizzo di Java - Java Use-API per HTL abilita un file HTL per accedere a metodi helper in una classe Java personalizzata. Questo consente di utilizzare il codice Java per implementare la logica per selezionare e configurare il contenuto del componente.
• Utilizzo di JavaScript - JavaScript Use-API per HTL abilita un file HTL per accedere a codice helper scritto in JavaScript. Questo consente di utilizzare il codice JavaScript per implementare la logica per selezionare e configurare il contenuto del componente.
• Utilizzo delle librerie lato client: i siti web moderni si basano in larga misura sull’elaborazione lato client guidata da codice JavaScript e CSS complesso. Consulta il documento Utilizzo di librerie lato client su AEM as a Cloud Service per ulteriori informazioni.

Struttura dei componenti

La struttura di una componente AEM è potente e flessibile. Le parti principali sono:

• Tipo risorsa
• Definizione componente
• Proprietà e nodi figlio di un componente
• Finestre di dialogo
• Finestre di dialogo per progettazione

Tipo risorsa

Un elemento chiave della struttura è il tipo di risorsa.

• La struttura del contenuto dichiara le intenzioni.
• Il tipo di risorsa li implementa.

Si tratta di un’astrazione che aiuta a garantire che, anche quando l’aspetto cambia nel tempo, l’intenzione rimanga nel tempo.

Definizione componente

La definizione di un componente può essere suddivisa come segue:

• I componenti AEM si basano su Sling.
• I componenti dell’AEM si trovano sotto /libs/core/wcm/components.
• I componenti specifici del progetto/sito si trovano in /apps/<myApp>/components.
• I componenti standard dell’AEM sono definiti come cq:Component e avere gli elementi chiave:
  • Proprietà jcr: elenco di proprietà jcr. Queste sono variabili e alcune possono essere facoltative, anche se la struttura di base di un nodo componente, le sue proprietà e i sottonodi sono definiti da cq:Component definizione.
  • Risorse: definiscono gli elementi statici utilizzati dal componente.
  • Script: vengono utilizzati per implementare il comportamento dell’istanza risultante del componente.

Proprietà vitali

• Nodo principale:
  • <mycomponent> (cq:Component) - Nodo gerarchico del componente.
• Proprietà vitali:
  • jcr:title - Titolo del componente; ad esempio, utilizzato come etichetta quando il componente è elencato in Browser Componenti e Console Componenti
  • jcr:description - Descrizione del componente; utilizzata come suggerimento del mouse nella console Browser componenti e Componenti
  • Consulta la sezione Icona componente per i dettagli
• Nodi figlio vitali:
  • cq:editConfig (cq:EditConfig) - Definisce le proprietà di modifica del componente e ne attiva la visualizzazione nel browser Componenti
    • Se il componente ha una finestra di dialogo, questa viene visualizzata automaticamente nel browser Componenti o nella barra laterale, anche se cq:editConfig non esiste.
  • cq:childEditConfig (cq:EditConfig) - Controlla gli aspetti dell’interfaccia utente di authoring per i componenti secondari che non definiscono i propri cq:editConfig.
  • cq:dialog (nt:unstructured) - Finestra di dialogo per questo componente. Definisce l’interfaccia che consente all’utente di configurare il componente e/o modificare il contenuto.
  • cq:design_dialog (nt:unstructured) - Modifica del design di questo componente

Icona componente

L’icona o l’abbreviazione del componente viene definita tramite le proprietà JCR del componente quando questo viene creato dallo sviluppatore. Queste proprietà vengono valutate nell'ordine seguente e viene utilizzata la prima proprietà valida trovata.

1. cq:icon : proprietà stringa che punta a un'icona standard nella Libreria interfaccia utente Coral da visualizzare nel browser componenti
   • Utilizza il valore dell’attributo HTML dell’icona Coral.
2. abbreviation - Proprietà stringa per personalizzare l'abbreviazione del nome del componente nel browser componenti
   • L’abbreviazione deve essere limitata a due caratteri.
   • Specificando una stringa vuota, verrà creata l’abbreviazione a partire dai primi due caratteri della jcr:title proprietà.
     • Ad esempio "Im" per "Immagine"
     • Per creare l’abbreviazione verrà utilizzato il titolo localizzato.
   • L’abbreviazione viene tradotta solo se il componente ha un abbreviation_commentI18n , che viene quindi utilizzata come suggerimento di traduzione.
3. cq:icon.png o cq:icon.svg : icona per questo componente, che viene visualizzata nel browser Componenti
   • 20 x 20 pixel sono le dimensioni delle icone dei componenti standard.
     • Le icone più grandi verranno ridimensionate (lato client).
   • Il colore consigliato è rgb(112, 112, 112) > #707070
   • Lo sfondo delle icone dei componenti standard è trasparente.
   • Solo .png e .svg sono supportati.
   • Se si importa dal file system tramite il plug-in Eclipse, i nomi dei file devono essere preceduti come _cq_icon.png o _cq_icon.svg ad esempio.
   • .png ha precedenza su .svg se sono presenti entrambi.

Se nessuna delle proprietà precedenti (cq:icon, abbreviation, cq:icon.png o cq:icon.svg) si trovano nel componente:

• Il sistema cercherà le stesse proprietà sui super componenti seguendo la sling:resourceSuperType proprietà.
• Se a livello di super componente non viene trovato nulla o un’abbreviazione vuota, il sistema crea l’abbreviazione dalle prime lettere del jcr:title del componente corrente.

Per annullare l’ereditarietà delle icone dai super componenti, imposta un valore vuoto abbreviation sul componente verrà ripristinato il comportamento predefinito.

Il Console Componenti mostra come viene definita l’icona di un particolare componente.

Esempio di icona SVG

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px"
     width="20px" height="20px" viewBox="0 0 20 20" enable-background="new 0 0 20 20" xml:space="preserve">
    <ellipse cx="5" cy="5" rx="3" ry="3" fill="#707070"/>
    <ellipse cx="15" cy="5" rx="4" ry="4" fill="#707070"/>
    <ellipse cx="5" cy="15" rx="5" ry="5" fill="#707070"/>
    <ellipse cx="15" cy="15" rx="4" ry="4" fill="#707070"/>
</svg>

Proprietà e nodi figlio di un componente

Molti nodi/proprietà necessari per definire un componente sono comuni a entrambe le interfacce, con differenze che rimangono indipendenti in modo che il componente possa funzionare in entrambi gli ambienti.

Un componente è un nodo di tipo cq:Component e ha le seguenti proprietà e nodi secondari:

Se consideriamo il Testo componente, possiamo vedere una serie di questi elementi:

Le proprietà di particolare interesse comprendono:

• jcr:title : titolo del componente utilizzato per identificare il componente nel browser Componenti.
• jcr:description - Questa è la descrizione del componente.
• sling:resourceSuperType - Indica il percorso di ereditarietà quando si estende un componente (sovrascrivendo una definizione).

I nodi figlio di particolare interesse includono:

• cq:editConfig - Questa opzione controlla gli aspetti visivi del componente durante la modifica.
• cq:dialog : definisce la finestra di dialogo per la modifica del contenuto di questo componente.
• cq:design_dialog - Specifica le opzioni di modifica della progettazione per questo componente.

Finestre di dialogo

Le finestre di dialogo sono un elemento chiave del componente in quanto forniscono un’interfaccia che consente agli autori di configurare il componente in una pagina di contenuto e fornire input per tale componente. Consulta la documentazione di authoring per informazioni dettagliate su come gli autori di contenuti interagiscono con i componenti.

A seconda della complessità del componente, la finestra di dialogo potrebbe richiedere una o più schede.

Finestre di dialogo per le componenti AEM:

• Sono cq:dialog nodi di tipo nt:unstructured.
• Si trovano sotto il loro cq:Component e accanto alle relative definizioni dei componenti.
• Definisci la finestra di dialogo per la modifica del contenuto di questo componente.
• Sono definiti utilizzando i componenti dell’interfaccia utente Granite.
• Viene eseguito il rendering lato server (come componenti Sling), in base alla struttura del contenuto e al sling:resourceType proprietà.
• Contengono una struttura di nodi che descrive i campi all’interno della finestra di dialogo
  • Questi nodi sono nt:unstructured con il necessario sling:resourceType proprietà.

Nella finestra di dialogo sono definiti i singoli campi:

Finestre di dialogo per progettazione

Le finestre di dialogo per progettazione sono simili alle finestre di dialogo utilizzate per modificare e configurare il contenuto, ma forniscono agli autori di modelli l’interfaccia per la pro-configurazione e i dettagli di progettazione per tale componente su un modello di pagina. I modelli di pagina vengono quindi utilizzati dagli autori dei contenuti per creare pagine di contenuto. Consulta la documentazione del modello per informazioni dettagliate sulla creazione dei modelli.

Le finestre di dialogo per progettazione vengono utilizzate quando si modifica un modello di pagina, anche se non sono necessari per tutti i componenti. Ad esempio, Titolo e Componenti immagine entrambi dispongono di finestre di dialogo di progettazione, mentre Componente condivisione social media non lo fa.

Coral UI e Granite UI

L’interfaccia utente Coral e Granite definiscono l’aspetto dell’AEM.

• Coral UI fornisce un’interfaccia utente coerente per tutte le soluzioni cloud.
• Interfaccia utente Granite fornisce il markup dell’interfaccia utente Coral racchiuso tra i componenti Sling per la creazione di console e finestre di dialogo dell’interfaccia utente.

L’interfaccia utente Granite offre una vasta gamma di widget di base necessari per creare la finestra di dialogo nell’ambiente di authoring. Se necessario, puoi estendere questa selezione e creare un widget personalizzato.

Per ulteriori informazioni, consulta le seguenti risorse:

• Struttura dell’interfaccia AEM

Personalizzazione dei campi della finestra di dialogo

Per creare un nuovo widget da utilizzare nella finestra di dialogo di un componente è necessario creare un nuovo componente campo dell’interfaccia utente Granite.

Se consideri la finestra di dialogo come un semplice contenitore per un elemento del modulo, puoi anche visualizzare il contenuto principale della finestra di dialogo come campi del modulo. La creazione di un nuovo campo modulo richiede la creazione di un tipo di risorsa, il che equivale alla creazione di un nuovo componente. Per facilitare questa attività, l’interfaccia utente Granite offre un componente campo generico da cui ereditare (utilizzando sling:resourceSuperType):

/libs/granite/ui/components/coral/foundation/form/field

Più precisamente, l’interfaccia utente Granite offre una serie di componenti di campo adatti all’utilizzo nelle finestre di dialogo o, più in generale, in moduli.

Dopo aver creato il tipo di risorsa, puoi creare un’istanza del campo aggiungendo un nuovo nodo nella finestra di dialogo, con la proprietà sling:resourceType facendo riferimento al tipo di risorsa appena introdotto.

Accesso ai campi della finestra di dialogo

È inoltre possibile utilizzare le condizioni di rendering (rendercondition) per controllare chi ha accesso a schede/campi specifici nella finestra di dialogo; ad esempio:

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

Utilizzo dei componenti

Dopo aver creato un componente, devi abilitarlo per poterlo utilizzare. Il suo utilizzo mostra come la struttura del componente è correlata alla struttura del contenuto risultante nell’archivio.

Aggiunta del componente al modello

Una volta definito un componente, questo deve essere reso disponibile per l’uso. Per rendere un componente disponibile per l’utilizzo in un modello, devi abilitarlo nel criterio del Contenitore di layout del modello.

Consulta la documentazione del modello per informazioni dettagliate sulla creazione dei modelli.

Componenti e contenuti creati

Se creiamo e configuriamo un’istanza di Titolo componente nella pagina: /content/wknd/language-masters/en/adventures/extreme-ironing.html

Quindi possiamo vedere la struttura del contenuto creato all’interno dell’archivio:

In particolare, se si considera il testo effettivo di un Componente Titolo:

• Il contenuto contiene un jcr:title proprietà contenente il testo effettivo del titolo immesso dall’autore.
• Contiene anche un sling:resourceType riferimento alla definizione del componente.

Le proprietà definite dipendono dalle singole definizioni. Anche se possono essere più complesse di quanto sopra, seguono comunque gli stessi principi di base.

Gerarchia dei componenti ed ereditarietà

I componenti dell’AEM sono soggetti agli Gerarchia dei tipi di risorsa. Viene utilizzato per estendere i componenti utilizzando la proprietà sling:resourceSuperType. Questo consente al componente di ereditare da un altro componente.

Consulta la sezione Riutilizzo dei componenti per ulteriori informazioni.

Modifica comportamento

Questa sezione spiega come configurare il comportamento di modifica di un componente. Ciò include attributi quali le azioni disponibili per il componente, le caratteristiche dell’editor in.place e i listener relativi agli eventi sul componente.

Il comportamento di modifica di un componente viene configurato aggiungendo un cq:editConfig nodo di tipo cq:EditConfig sotto il nodo del componente (di tipo cq:Component) e aggiungendo proprietà e nodi secondari specifici. Sono disponibili le seguenti proprietà e nodi figlio:

• cq:editConfig proprietà nodo
• cq:editConfig nodi secondari:
  • cq:dropTargets (tipo di nodo nt:unstructured): definisce un elenco di destinazioni di rilascio che possono accettare un rilascio da una risorsa di content finder (è consentita una singola destinazione di rilascio)
  • cq:inplaceEditing (tipo di nodo cq:InplaceEditingConfig): definisce una configurazione per la modifica diretta del componente
  • cq:listeners (tipo di nodo cq:EditListenersConfig): definisce cosa accade prima o dopo che si verifica un’azione sul componente

Ci sono molte configurazioni esistenti nell'AEM. Puoi cercare facilmente proprietà specifiche o nodi secondari utilizzando lo strumento Query in CRXDE Lite.

Segnaposto Componente

I componenti devono sempre eseguire il rendering di alcuni HTML visibili all’autore, anche quando il componente non ha contenuto. In caso contrario, potrebbe scomparire visivamente dall’interfaccia dell’editor, rendendolo tecnicamente presente ma invisibile nella pagina e nell’editor. In questo caso, gli autori non potranno selezionare e interagire con il componente vuoto.

Per questo motivo, i componenti devono eseguire il rendering di un segnaposto, a condizione che non eseguano il rendering di alcun output visibile quando la pagina viene riprodotta nell’editor di pagine (quando la modalità WCM è edit o preview).
Il markup HTML tipico per un segnaposto è il seguente:

<div class="cq-placeholder" data-emptytext="Component Name"></div>

HTML Il tipico script HTL che esegue il rendering del segnaposto sopra riportato è il seguente:

<div class="cq-placeholder" data-emptytext="${component.properties.jcr:title}"
     data-sly-test="${(wcmmode.edit || wcmmode.preview) && isEmpty}"></div>

Nell’esempio precedente, isEmpty è una variabile che è true solo quando il componente non ha contenuto ed è invisibile all’autore.

Per evitare ripetizioni, l’Adobe consiglia agli implementatori di componenti di utilizzare un modello HTL per questi segnaposto, come quello fornito dai Componenti core.

L’utilizzo del modello nel collegamento precedente viene quindi eseguito con la seguente riga di HTL:

<sly data-sly-use.template="core/wcm/components/commons/v1/templates.html"
     data-sly-call="${template.placeholder @ isEmpty=!model.text}"></sly>

Nell’esempio precedente, model.text è la variabile che è true solo quando il contenuto ha contenuto ed è visibile.

Un esempio di utilizzo di questo modello è disponibile nei Componenti core, come nel componente Titolo.

Configurazione con i nodi secondari cq:EditConfig

Eliminazione di risorse in una finestra di dialogo - cq:dropTargets

Il cq:dropTargets nodo (tipo di nodo) nt:unstructured) definisce la destinazione di rilascio in grado di accettare un rilascio da una risorsa trascinata da content finder. È un nodo di tipo cq:DropTargetConfig.

Nodo figlio di tipo cq:DropTargetConfig definisce una destinazione di rilascio nel componente.

Modifica diretta - cq:inplaceEditing

Un editor locale consente all’utente di modificare il contenuto direttamente nel flusso di contenuto, senza dover aprire una finestra di dialogo. Ad esempio, lo standard Testo e Titolo entrambi i componenti dispongono di un editor locale.

Non è necessario/significativo un editor locale per ogni tipo di componente.

Il cq:inplaceEditing nodo (tipo di nodo) cq:InplaceEditingConfig) definisce una configurazione di modifica diretta per il componente. Può avere le seguenti proprietà:

La seguente configurazione abilita la modifica diretta del componente e definisce plaintext come tipo di editor:

    <cq:inplaceEditing
        jcr:primaryType="cq:InplaceEditingConfig"
        active="{Boolean}true"
        editorType="plaintext"/>

Gestione degli eventi dei campi - cq:listeners

Il metodo di gestione degli eventi sui campi della finestra di dialogo viene eseguito con i listener in un libreria client.

Per inserire la logica nel campo, è necessario:

• Fai marcare il campo con una determinata classe CSS (l’hook).
• Definisci nella libreria client un listener JS collegato al nome di classe CSS (in modo che la logica personalizzata abbia ambito solo sul tuo campo e non influisca su altri campi dello stesso tipo).

A questo scopo, è necessario conoscere la libreria di widget sottostante con cui desideri interagire. Consulta la documentazione sull’interfaccia utente Coral per identificare a quale evento desideri reagire.

Il cq:listeners nodo (tipo di nodo) cq:EditListenersConfig) definisce cosa accade prima o dopo un’azione sul componente. La tabella seguente definisce le proprietà possibili.

Il gestore eventi può essere implementato con un’implementazione personalizzata. Ad esempio (dove project.customerAction è un metodo statico):

afteredit = "project.customerAction"

L’esempio seguente è equivalente al REFRESH_INSERTED configurazione:

afterinsert="function(path, definition) { this.refreshCreated(path, definition); }"

Con la seguente configurazione la pagina viene aggiornata dopo che il componente è stato eliminato, modificato, inserito o spostato:

    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="REFRESH_PAGE"
        afteredit="REFRESH_PAGE"
        afterinsert="REFRESH_PAGE"
        afterMove="REFRESH_PAGE"/>

Convalida campo

La convalida dei campi nell’interfaccia utente Granite e nei widget dell’interfaccia utente Granite viene eseguita utilizzando foundation-validation API. Consulta la foundation-valdiation Documentazione di Granite per i dettagli.

Rilevamento della disponibilità della finestra di dialogo

Se disponi di un JavaScript personalizzato che deve essere eseguito solo quando la finestra di dialogo è disponibile e pronta, è necessario ascoltare dialog-ready evento.

Questo evento viene attivato ogni volta che la finestra di dialogo viene caricata (o ricaricata) ed è pronta per l’uso, ovvero ogni volta che si verifica una modifica (creazione/aggiornamento) nel DOM della finestra di dialogo.

dialog-ready può essere utilizzato per hook nel codice personalizzato JavaScript che esegue personalizzazioni sui campi all’interno di una finestra di dialogo o attività simili.

Anteprima comportamento

Il Modalità WCM Il cookie viene impostato quando si passa alla modalità Anteprima anche quando la pagina non viene aggiornata.

Per i componenti con un rendering sensibili alla modalità WCM, è necessario definirli per aggiornarsi in modo specifico e quindi basarsi sul valore del cookie.

Documentazione dei componenti

In qualità di sviluppatore, desideri poter accedere facilmente alla documentazione dei componenti per comprendere rapidamente i relativi:

• Descrizione
• Uso previsto
• Struttura e proprietà del contenuto
• API e punti di estensione esposti
• Ecc.

Per questo motivo, è molto semplice creare qualsiasi markdown della documentazione esistente disponibile all’interno del componente stesso.

È sufficiente inserire un README.md nella struttura dei componenti.

Questo markdown verrà quindi visualizzato nel Console Componenti.

Il markdown supportato è lo stesso di Frammenti di contenuto.

Risorse Business.Adobe.com