Sviluppo di componenti AEM developing-aem-components

I componenti AEM vengono utilizzati per memorizzare, formattare ed eseguire il rendering dei contenuti resi disponibili sulle pagine web.

Esempi di codice code-samples

Questa pagina fornisce la documentazione di riferimento (o collegamenti alla documentazione di riferimento) necessaria per sviluppare nuovi componenti per l’AEM. Per alcuni esempi pratici, consulta Sviluppo di componenti AEM: esempi di codice.

Struttura structure

La struttura di base di un componente è illustrata nella pagina Componenti AEM - Nozioni di base. Questo documento descrive sia le interfacce utente touch che quelle classiche. Anche se non devi utilizzare le impostazioni classiche nel nuovo componente, può essere utile tenerne conto durante l’ereditarietà dai componenti esistenti.

Estensione di finestre di dialogo e componenti esistenti extending-existing-components-and-dialogs

A seconda del componente che si desidera implementare, è possibile estendere o personalizzare un'istanza esistente anziché definire e sviluppare l'intera struttura da zero.

Quando estendi o personalizzi un componente o una finestra di dialogo esistente, puoi copiare o replicare l’intera struttura o la struttura necessaria per la finestra di dialogo prima di apportare le modifiche.

Estensione di un componente esistente extending-an-existing-component

L'estensione di un componente esistente può essere ottenuta con Resource Type Hierarchy e i relativi meccanismi di ereditarietà.

Personalizzazione di una finestra di dialogo di componente esistente customizing-a-existing-component-dialog

È inoltre possibile ignorare una finestra di dialogo del 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 (utilizzando sling:resourceSuperType). Questo è ora un metodo consigliato per estendere la finestra di dialogo di un componente

Per ulteriori dettagli, vedi Sling Resource Merger.

Definizione del markup defining-the-markup

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.

Utilizzo di HTML Template Language using-the-html-template-language

HTML Template Language (HTL), introdotto con AEM 6.0, sostituisce JSP (JavaServer Pages) come sistema di modelli lato server preferito e consigliato per HTML. Per gli sviluppatori web che devono creare solidi siti web aziendali, HTL consente di ottenere una maggiore sicurezza ed efficienza dello sviluppo.

Sviluppo della logica dei contenuti developing-the-content-logic

Questa logica facoltativa seleziona e/o calcola il contenuto di cui eseguire il rendering. Viene richiamato da espressioni HTL con il pattern Use-API appropriato.

Il meccanismo per separare la logica dall'aspetto aiuta a chiarire ciò che viene chiamato per una determinata vista. Consente inoltre una logica diversa per le diverse viste della stessa risorsa.

Utilizzo di Java using-java

Java Use-API per HTL consente a un file HTL di 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 using-javascript

HTL JavaScript Use-API consente a un file HTL di accedere a codice helper scritto in JavaScript. Questo consente di utilizzare il codice JavaScript per implementare la logica per la selezione e la configurazione del contenuto del componente.

Utilizzo delle librerie HTML lato client using-client-side-html-libraries

I siti web moderni si basano in larga misura sull’elaborazione lato client guidata da codice JavaScript e CSS complesso. L’organizzazione e l’ottimizzazione della trasmissione di questo codice possono essere un problema complesso.

Per risolvere questo problema, AEM fornisce Cartelle libreria lato client, che consente di memorizzare il codice lato client nell'archivio, organizzarlo in categorie e definire quando e come ogni categoria di codice deve essere servita al client. Il sistema di librerie lato client si occupa quindi di generare i collegamenti corretti nella pagina web finale per caricare il codice corretto.

Per ulteriori informazioni, leggere Utilizzo delle librerie HTML lato client.

Configurazione del comportamento di modifica configuring-the-edit-behavior

Puoi configurare il comportamento di modifica di un componente, inclusi gli attributi quali le azioni disponibili per il componente, le caratteristiche dell’editor locale e i listener relativi agli eventi sul componente. La configurazione è comune sia all’interfaccia touch che a quella classica, anche se con alcune differenze specifiche.

Il comportamento di modifica di un componente è configurato aggiungendo un nodo cq:editConfig di tipo cq:EditConfig sotto il nodo del componente (di tipo cq:Component) e aggiungendo proprietà specifiche e nodi figlio.

Configurazione del comportamento di anteprima configuring-the-preview-behavior

Il cookie della modalità WCM viene impostato quando si passa alla modalità Anteprima anche se 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.

Creazione e configurazione di una finestra di dialogo creating-and-configuring-a-dialog

Le finestre di dialogo vengono utilizzate per consentire all’autore di interagire con il componente. Una finestra di dialogo consente agli autori e/o agli amministratori di modificare il contenuto, configurare il componente o definire i parametri di progettazione (utilizzando una finestra di dialogo per progettazione)

Coral UI e Granite UI coral-ui-and-granite-ui

Coral UI e Granite UI definiscono l'aspetto moderno dell'AEM.

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

Per maggiori dettagli, consulta:

Creazione di una nuova finestra di dialogo creating-a-new-dialog

Finestre di dialogo per l’interfaccia touch:

Un esempio di struttura dei nodi potrebbe essere:

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

La personalizzazione di una finestra di dialogo è simile allo sviluppo di un componente, in quanto la finestra di dialogo stessa è un componente (ovvero, un markup rappresentato da uno script di componente insieme al comportamento/stile fornito da una libreria client).

Per esempi, consulta:

Personalizzazione dei campi della finestra di dialogo customizing-dialog-fields

Creazione di un nuovo campo creating-a-new-field

I widget per l’interfaccia utente touch vengono implementati come componenti dell’interfaccia utente Granite.

Per creare un widget da utilizzare in una finestra di dialogo di un componente per l'interfaccia utente touch, è necessario creare un 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 campo modulo richiede la creazione di un tipo di risorsa, il che equivale alla creazione di un 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 fornisce 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, è possibile creare un'istanza del campo aggiungendo un nuovo nodo nella finestra di dialogo, con la proprietà sling:resourceType che fa riferimento al tipo di risorsa appena introdotto.

Creazione di una libreria client per stile e comportamento creating-a-client-library-for-style-and-behavior

Se desideri definire lo stile e il comportamento del componente, puoi creare una libreria client dedicata che definisce i tuoi file CSS/LESS e JS personalizzati.

Per caricare la libreria client solo per la finestra di dialogo del componente, ovvero non per un altro componente, è necessario impostare la proprietà extraClientlibs della finestra di dialogo sul nome della categoria della libreria client creata. Questa opzione è consigliata se la libreria client è molto grande e/o il campo è specifico per tale finestra di dialogo e non sarà necessario in altre finestre di dialogo.

Per caricare la libreria client per tutte le finestre di dialogo, impostare la proprietà category della libreria client su cq.authoring.dialog. Questo è il nome della categoria della libreria client che viene inclusa per impostazione predefinita durante il rendering di tutte le finestre di dialogo. Puoi eseguire questa operazione se la libreria client è piccola e/o il campo è generico e potrebbe essere riutilizzato in altre finestre di dialogo.

Ad esempio, consulta:

Estensione (ereditarietà) di un campo extending-inheriting-from-a-field

A seconda delle tue esigenze, puoi effettuare le seguenti operazioni:

Accesso ai campi della finestra di dialogo access-to-dialog-fields

È 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"]

Gestione degli eventi dei campi handling-field-events

Il metodo di gestione degli eventi nei campi della finestra di dialogo è ora eseguito con listener in una libreria client personalizzata. Si tratta di una modifica rispetto al metodo precedente di avere listener nella struttura del contenuto.

Listener in una libreria client personalizzata listeners-in-a-custom-client-library

Per inserire la logica nel campo, è necessario:

A questo scopo, è necessario conoscere la libreria di widget sottostante con cui desideri interagire. Consulta la documentazione dell'interfaccia utente Coral per identificare l'evento a cui desideri reagire. Questo processo è molto simile a quello che dovevi eseguire con ExtJS in passato: trova la pagina della documentazione di un dato widget, quindi controlla i dettagli dell'API dell'evento.

Ad esempio, consulta:

Listener nella struttura del contenuto listeners-in-the-content-structure

Nell’interfaccia classica con ExtJS, solitamente i listener per un determinato widget erano inclusi nella struttura del contenuto. Ottenere lo stesso risultato nell’interfaccia touch è diverso in quanto il codice del listener JS (o qualsiasi codice) non è più definito nel contenuto.

La struttura del contenuto descrive la struttura semantica; non dovrebbe (deve) implicare la natura del widget sottostante. Se nella struttura del contenuto non è presente codice JS, puoi modificare i dettagli di implementazione senza dover modificare la struttura del contenuto. In altre parole, è possibile modificare la libreria dei widget senza dover toccare la struttura del contenuto.

Rilevamento della disponibilità della finestra di dialogo dialog-ready

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

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 eseguire l'hook nel codice personalizzato di JavaScript che esegue personalizzazioni sui campi all'interno di una finestra di dialogo o attività simili.

Convalida campo field-validation

Campo obbligatorio mandatory-field

Per contrassegnare un determinato campo come obbligatorio, imposta la seguente proprietà sul nodo di contenuto del campo:

Ad esempio, consulta:

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

Convalida del campo (interfaccia utente Granite) field-validation-granite-ui

La convalida dei campi nell'interfaccia utente Granite e nei componenti dell'interfaccia utente Granite (equivalenti ai widget) viene eseguita utilizzando l'API foundation-validation. Per informazioni dettagliate, vedere la documentazione di foundation-valdiation Granite.

Per esempi, consulta:

Creazione e configurazione di una finestra di dialogo per progettazione creating-and-configuring-a-design-dialog

La finestra di dialogo per progettazione viene visualizzata quando un componente presenta dettagli di progettazione che è possibile modificare in Modalità progettazione.

La definizione è molto simile a quella di una finestra di dialogo utilizzata per modificare il contenuto, con la differenza che è definita come nodo:

Creazione e configurazione di un Inplace Editor creating-and-configuring-an-inplace-editor

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

Un editor locale non è necessario/significativo per ogni tipo di componente.

Per ulteriori informazioni, vedere Estensione dell'authoring delle pagine - Aggiunta di un nuovo editor locale.

Personalizzazione della barra degli strumenti del componente customizing-the-component-toolbar

La Barra degli strumenti del componente consente all'utente di accedere a una serie di azioni per il componente, ad esempio modifica, configurazione, copia ed eliminazione.

Per ulteriori informazioni, vedere Estensione dell'authoring delle pagine - Aggiunta di una nuova azione alla barra degli strumenti di un componente.

Configurazione di un componente per la barra dei riferimenti (in prestito/preso in prestito) configuring-a-component-for-the-references-rail-borrowed-lent

Se il nuovo componente fa riferimento a contenuto proveniente da altre pagine, puoi valutare se influire sulle sezioni Contenuto in prestito e Contenuto prestato della barra Riferimenti.

L’AEM preconfigurato controlla solo il componente Reference. Per aggiungere il componente è necessario configurare il bundle OSGi WCM Authoring Content Reference Configuration.

Crea una voce nella definizione, specificando il componente, insieme alla proprietà da controllare. Ad esempio:

/apps/<*your-Project*>/components/reference@parentPath

Abilitazione e aggiunta del componente al sistema dei paragrafi enabling-and-adding-your-component-to-the-paragraph-system

Una volta sviluppato, il componente deve essere abilitato per l’utilizzo in un sistema paragrafo appropriato, in modo da poter essere utilizzato nelle pagine richieste.

Questa operazione può essere eseguita da:

Configurazione di un sistema di paragrafi in modo che il trascinamento di una risorsa crei un’istanza di componente configuring-a-paragraph-system-so-that-dragging-an-asset-creates-a-component-instance

AEM offre la possibilità di configurare un sistema paragrafo nella pagina in modo che un'istanza del nuovo componente venga creata automaticamente quando un utente trascina una risorsa (appropriata) in un'istanza della pagina (invece di dover sempre trascinare un componente vuoto nella pagina).

È possibile configurare questo comportamento e la relazione risorsa-componente richiesta:

Per esempi, consulta:

CODICE SU GITHUB

Puoi trovare il codice di questa pagina su GitHub

Utilizzo dell’estensione per Brackets dell’AEM using-the-aem-brackets-extension

L'estensione Brackets AEM fornisce un flusso di lavoro fluido per modificare i componenti AEM e le librerie client. È basato sull'editor di codice Brackets.

L’estensione:

Migrazione da un componente classico migrating-from-a-classic-component

Quando si migra un componente progettato per essere utilizzato con l’interfaccia classica a un componente che può essere utilizzato con l’interfaccia touch (singolarmente o congiuntamente), è necessario considerare i seguenti problemi:

Migrazione di cq:codice listener migrating-cq-listener-code

Se si sta eseguendo la migrazione di un progetto progettato per l'interfaccia utente classica, è possibile che il codice cq:listener (e le clientlibs correlate al componente) utilizzino funzioni specifiche dell'interfaccia utente classica (ad esempio CQ.wcm.*). Per la migrazione è necessario aggiornare tale codice utilizzando gli oggetti/le funzioni equivalenti nell’interfaccia utente touch.

Se il progetto viene completamente migrato all’interfaccia touch, devi sostituire tale codice per utilizzare gli oggetti e le funzioni rilevanti per tale interfaccia.

Tuttavia, se il progetto deve soddisfare sia l’interfaccia utente classica che quella touch durante il periodo di migrazione (lo scenario usuale), devi implementare un’opzione per differenziare il codice separato che fa riferimento agli oggetti appropriati.

Questo meccanismo di cambio può essere implementato come:

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

Documentazione del componente documenting-your-component

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

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

Inserire un file README.md nella struttura del componente. Questo markdown viene visualizzato nella console componenti.

Il markdown supportato è lo stesso dei frammenti di contenuto.