Il campo di testo su più righe è un tipo di dati Frammenti di contenuto che consente agli autori di creare contenuti di testo RTF. I riferimenti ad altri contenuti, come immagini o altri frammenti di contenuto, possono essere inseriti in linea in modo dinamico all’interno del flusso di testo. Il campo di testo a riga singola è un altro tipo di dati Frammenti di contenuto che deve essere utilizzato per elementi di testo semplici.
AEM’API GraphQL offre una solida capacità di restituire testo RTF come HTML, testo normale o come JSON puro. La rappresentazione JSON è potente in quanto offre all’applicazione client il pieno controllo su come eseguire il rendering del contenuto.
Nell’Editor frammento di contenuto, la barra dei menu del campo di testo su più righe offre agli autori funzionalità di formattazione RTF standard, ad esempio audace, corsivo e sottolineano. L'apertura del campo multiriga in modalità a schermo intero abilita strumenti di formattazione aggiuntivi come tipo di paragrafo, trova e sostituisci, controllo ortografico e altro ancora.
Non è possibile personalizzare i plug-in RTF nell’editor su più righe.
Utilizza la Testo su più righe tipo di dati durante la definizione del modello di frammento di contenuto per abilitare la creazione di testo RTF.
È possibile configurare diverse proprietà del campo a più righe.
La Rendering come può essere impostata su:
La Tipo predefinito può essere impostato su:
La Tipo predefinito influenza direttamente l’esperienza di modifica e determina se sono presenti gli strumenti rich text.
È inoltre possibile abilita riferimenti in linea ad altri frammenti di contenuto selezionando la Consenti riferimento frammento e la configurazione Modelli di frammenti di contenuto consentiti.
Controlla la Traducibile se il contenuto deve essere localizzato. È possibile localizzare solo il testo RTF e il testo normale. Vedi utilizzo dei contenuti localizzati per ulteriori dettagli.
Quando crei una query GraphQL, gli sviluppatori possono scegliere diversi tipi di risposta da html
, plaintext
, markdown
e json
da un campo con più righe.
Gli sviluppatori possono utilizzare Anteprima JSON nell’editor Frammento di contenuto per mostrare tutti i valori del frammento di contenuto corrente che possono essere restituiti utilizzando l’API GraphQL.
Selezione della json
il formato di risposta per il campo a più righe offre la massima flessibilità quando si lavora con contenuti rich text. Il contenuto RTF viene consegnato come array di tipi di nodi JSON che possono essere elaborati in modo univoco in base alla piattaforma client.
Di seguito è riportato un tipo di risposta JSON di un campo multi-riga denominato main
che contiene un paragrafo: "Questo è un paragrafo che include importantecontenuto." dove "importante" è contrassegnato come audace.
query ($path: String!) {
articleByPath(_path: $path)
{
item {
_path
main {
json
}
}
}
}
La $path
nella variabile _path
Il filtro richiede il percorso completo del frammento di contenuto (ad esempio /content/dam/wknd/en/magazine/sample-article
).
Risposta GraphQL:
{
"data": {
"articleByPath": {
"item": {
"_path": "/content/dam/wknd/en/magazine/sample-article",
"main": {
"json": [
{
"nodeType": "paragraph",
"content": [
{
"nodeType": "text",
"value": "This is a paragraph that includes "
},
{
"nodeType": "text",
"value": "important",
"format": {
"variants": [
"bold"
]
}
},
{
"nodeType": "text",
"value": " content. "
}
]
}
]
}
}
}
}
}
Di seguito sono riportati diversi esempi di tipi di risposta di un campo con più righe denominato main
che contiene un paragrafo: "Questo è un paragrafo che include importante content." dove "importante" è contrassegnato come audace.
Esempio +++HTML
Query persistente GraphQL:
query ($path: String!) {
articleByPath(_path: $path)
{
item {
_path
main {
html
}
}
}
}
Risposta GraphQL:
{
"data": {
"articleByPath": {
"item": {
"_path": "/content/dam/wknd/en/magazine/sample-article",
"main": {
"html": "<p>This is a paragraph that includes <b>important</b> content. </p>\n"
}
}
}
}
}
+++
Query persistente GraphQL:
query ($path: String!) {
articleByPath(_path: $path)
{
item {
_path
main {
markdown
}
}
}
}
Risposta GraphQL:
{
"data": {
"articleByPath": {
"item": {
"_path": "/content/dam/wknd/en/magazine/sample-article",
"main": {
"markdown": "This is a paragraph that includes **important** content. \n\n ",
}
}
}
}
}
++Esempio di testo normale
Query persistente GraphQL:
query ($path: String!) {
articleByPath(_path: $path)
{
item {
_path
main {
plaintext
}
}
}
}
Risposta GraphQL:
{
"data": {
"articleByPath": {
"item": {
"_path": "/content/dam/wknd/en/magazine/sample-article",
"main": {
"plaintext": "This is a paragraph that includes important content. ",
}
}
}
}
}
La plaintext
l’opzione di rendering elimina qualsiasi formattazione.
+++
La risposta JSON in formato RTF del campo a più righe è strutturata in una struttura gerarchica. Ogni oggetto o nodo rappresenta un blocco HTML diverso del testo RTF.
Di seguito è riportato un esempio di risposta JSON di un campo di testo su più righe. Osserva che ogni oggetto, o nodo, include un nodeType
che rappresenta il blocco HTML dal testo RTF come paragraph
, link
e text
. Ogni nodo contiene facoltativamente content
che è un sottoarray contenente elementi secondari del nodo corrente.
"json": [// root "content" or child nodes
{
"nodeType": "paragraph", // node for a paragraph
"content": [ // children of current node
{
"nodeType": "text", // node for a text
"value": "This is the first paragraph. "
},
{
"nodeType": "link",
"data": {
"href": "http://www.adobe.com"
},
"value": "An external link"
}
],
},
{
"nodeType": "paragraph",
"content": [
{
"nodeType": "text",
"value": "This is the second paragraph."
},
],
},
]
Il modo più semplice per eseguire il rendering su più righe json
la risposta consiste nell'elaborare ogni oggetto, o nodo, nella risposta ed elaborare tutti gli elementi secondari del nodo corrente. Una funzione ricorsiva può essere utilizzata per attraversare la struttura JSON.
Di seguito è riportato un codice di esempio che illustra un approccio di traversata ricorsivo. Gli esempi sono basati su JavaScript e utilizzano React's JSXTuttavia, i concetti di programmazione possono essere applicati a qualsiasi lingua.
// renderNodeList - renders a list of nodes
function renderNodeList(childNodes) {
if(!childNodes) {
// null check
return null;
}
return childNodes.map(node, index) => {
return renderNode(node);
}
}
renderNodeList
è una funzione ricorsiva che richiede un array di childNodes
. Ogni nodo dell'array viene quindi trasmesso a una funzione renderNode
, che a sua volta chiama renderNodeList
se il nodo ha elementi figlio.
// renderNode - renders an individual node
function renderNode(node) {
// if the current node has children, recursively process them
const children = node.content ? renderNodeList(node.content) : null;
// use a map to render the current node based on its nodeType
return nodeMap[node.nodeType]?.(node, children);
}
La renderNode
la funzione richiede un singolo oggetto denominato node
. Un nodo può avere elementi secondari elaborati in modo ricorsivo utilizzando renderNodeList
funzione descritta sopra. Infine, un nodeMap
viene utilizzato per eseguire il rendering del contenuto del nodo in base al relativo nodeType
.
// nodeMap - object literal that maps a JSX response based on a given key (nodeType)
const nodeMap = {
'paragraph': (node, children) => <p>{children}</p>,
'link': node => <a href={node.data.href} target={node.data.target}>{node.value}</a>,
'text': node => node.value,
'unordered-list': (node, children) => <ul>{children}</ul>,
'ordered-list': (node, children) => <ol>{children}</ol>,
'list-item': (node, children) => <li>{children}</li>,
...
}
La nodeMap
è un valore letterale di oggetto JavaScript utilizzato come mappa. Ognuna delle "chiavi" rappresenta un nodeType
. Parametri di node
e children
può essere passato alle funzioni risultanti che eseguono il rendering del nodo. Il tipo restituito utilizzato in questo esempio è JSX, tuttavia l’approccio può essere adattato per creare un valore letterale stringa che rappresenta il contenuto HTML.
Un'utilità riutilizzabile per il rendering di testo RTF si trova in Esempio di reazione grafico WKND.
mapJsonRichText
. Questa utility può essere utilizzata dai componenti che desiderano eseguire il rendering di una risposta JSON RTF come React JSX.mapJsonRichText
utilità per eseguire il rendering del testo RTF e di eventuali riferimenti.Il campo Multiline consente agli autori di inserire immagini o altre risorse digitali da AEM Assets nel flusso del testo RTF.
La schermata precedente mostra un'immagine inserita nel campo multivalore utilizzando Inserisci risorsa pulsante .
È inoltre possibile collegare o inserire riferimenti ad altri frammenti di contenuto nel campo multivalore utilizzando Inserisci frammento di contenuto pulsante .
La schermata precedente mostra un altro frammento di contenuto, Guida completa ai parchi di Skate LA, inserito nel campo multi-riga. I tipi di frammenti di contenuto che possono essere inseriti nel campo sono controllati dalla Modelli di frammenti di contenuto consentiti nella configurazione tipo di dati multi-riga nel modello Frammento di contenuto.
L’API GraphQL consente agli sviluppatori di creare una query che include proprietà aggiuntive su eventuali riferimenti inseriti in un campo multi-riga. La risposta JSON include un _references
oggetto in cui sono elencate queste proprietà aggiuntive. La risposta JSON offre agli sviluppatori un controllo completo su come eseguire il rendering dei riferimenti o dei collegamenti invece di dover gestire HTML con opinioni critiche.
Ad esempio:
src
valore.Utilizza la json
tipo di ritorno e include _references
oggetto durante la costruzione di una query GraphQL:
Query persistente GraphQL:
query ($path: String!) {
articleByPath(_path: $path)
{
item {
_path
main {
json
}
}
_references {
...on ImageRef {
_path
_publishUrl
width
__typename
}
...on ArticleModel {
_path
author
__typename
}
}
}
}
Nella query precedente, la main
viene restituito come JSON. La _references
l'oggetto include frammenti per la gestione di riferimenti di tipo ImageRef
o di tipo ArticleModel
.
Risposta JSON:
{
"data": {
"articleByPath": {
"item": {
"_path": "/content/dam/wknd/en/magazine/sample-article",
"main": {
"json": [
{
"nodeType": "paragraph",
"content": [
{
"nodeType": "text",
"value": "This is a paragraph that includes "
},
{
"nodeType": "text",
"value": "important",
"format": {
"variants": [
"bold"
]
}
},
{
"nodeType": "text",
"value": " content. "
}
]
},
{
"nodeType": "paragraph",
"content": [
{
"nodeType": "reference",
"data": {
"path": "/content/dam/wknd/en/activities/climbing/sport-climbing.jpg",
"mimetype": "image/jpeg"
}
}
]
},
{
"nodeType": "paragraph",
"content": [
{
"nodeType": "text",
"value": "Reference another Content Fragment: "
},
{
"nodeType": "reference",
"data": {
"href": "/content/dam/wknd/en/magazine/la-skateparks/ultimate-guide-to-la-skateparks",
"type": "fragment"
},
"value": "Ultimate Guide to LA Skateparks"
}
]
}
]
}
},
"_references": [
{
"_path": "/content/dam/wknd/en/activities/climbing/sport-climbing.jpg",
"_publishUrl": "http://publish-p123-e456.adobeaemcloud.com/content/dam/wknd/en/activities/climbing/sport-climbing.jpg",
"width": 1920,
"__typename": "ImageRef"
},
{
"_path": "/content/dam/wknd/en/magazine/la-skateparks/ultimate-guide-to-la-skateparks",
"author": "Stacey Roswells",
"__typename": "ArticleModel"
}
]
}
}
}
La risposta JSON include dove il riferimento è stato inserito nel testo RTF con "nodeType": "reference"
. La _references
include quindi ogni riferimento con le proprietà aggiuntive richieste. Ad esempio, il ImageRef
restituisce il width
dell’immagine a cui si fa riferimento nell’articolo.
Per eseguire il rendering dei riferimenti in linea, l’approccio ricorsivo illustrato in Rendering di una risposta JSON multi-riga può essere espanso.
Dove nodeMap
è la mappa che esegue il rendering dei nodi JSON.
const nodeMap = {
'reference': (node, children) => {
// variable for reference in _references object
let reference;
// asset reference
if(node.data.path) {
// find reference based on path
reference = references.find( ref => ref._path === node.data.path);
}
// Fragment Reference
if(node.data.href) {
// find in-line reference within _references array based on href and _path properties
reference = references.find( ref => ref._path === node.data.href);
}
// if reference found, merge properties of reference and current node, then return render method of it using __typename property
return reference ? renderReference[reference.__typename]({...reference, ...node}) : null;
}
}
L'approccio di alto livello è quello di controllare ogni volta che un nodeType
è reference
nella risposta JSON Mutli Line. È quindi possibile chiamare una funzione di rendering personalizzata che include _references
oggetto restituito nella risposta GraphQL.
Il percorso di riferimento in linea può quindi essere confrontato con la voce corrispondente nel _references
oggetto e un'altra mappa personalizzata renderReference
può essere chiamato.
const renderReference = {
// node contains merged properties of the in-line reference and _references object
'ImageRef': (node) => {
// when __typename === ImageRef
return <img src={node._publishUrl} alt={'in-line reference'} />
},
'ArticleModel': (node) => {
// when __typename === ArticleModel
return <Link to={`/article:${node._path}`}>{`${node.value}`}</Link>;
}
...
}
La __typename
del _references
può essere utilizzato per mappare diversi tipi di riferimento a diverse funzioni di rendering.
Un esempio completo di scrittura di un renderer di riferimenti personalizzati si trova in AdventureDetail.js come parte del Esempio di reazione grafico WKND.
Il video precedente mostra un esempio end-to-end:
_references
utilizzato.