Composant
Un composant, dans Jahia, est l’association d’un contenu (fondé sur un type de contenu) et d’une vue, qui produit un morceau de page web (un fragment HTML) affiché aux visiteurs. C’est ce que les contributeurs manipulent concrètement lorsqu’ils composent une page : une actualité, un bandeau, un encadré, une liste. Ils saisissent des informations structurées ; la présentation, elle, est prise en charge par la vue.
Définition et fonctionnement
La séparation entre le fond et la forme permet à un même contenu d’avoir plusieurs vues. Une actualité peut s’afficher en carte dans une liste, en version complète sur sa propre page ou en simple titre dans un fil. Dans Content Editor, la section Layout permet au contributeur de choisir la vue parmi celles que les développeurs ont prévues.
Côté technique, le type de contenu définit les propriétés ; la vue est un morceau de code qui transforme en HTML un contenu stocké dans le référentiel de Jahia. Types et vues sont écrits par les développeurs et livrés ensemble dans des modules, des paquets de code déployés sur la plateforme.
Documentation Academy : le rendu des contenus
Termes liés : Vue · Content item · Type de contenu · Content Editor
Ressources sur ce terme
Le composant et le type de contenu : les différences
Le composant n’existe pas seul. Il naît de la rencontre d’une structure et d’un rendu. Les trois notions se confondent souvent dans le vocabulaire courant d’un projet.
| Notion | Place par rapport au composant |
|---|---|
| Type de contenu | Le type définit la structure : quels champs, de quelle nature. Le composant utilise un contenu de ce type et lui ajoute un rendu. |
| Content item | L’élément de contenu porte les valeurs saisies. Il peut exister sans être affiché, par exemple dans un dossier consommé par une application via l’API. |
| Vue | La vue est le code de rendu. Le composant est le résultat visible : ce contenu, rendu par cette vue, à cet endroit de la page. |
Le composant en pratique
Une équipe communication publie une actualité une seule fois. Sur la page d’accueil, elle apparaît en carte avec image et chapeau. Dans la colonne latérale d’une rubrique, elle n’affiche que son titre et sa date. Sur sa propre page, elle s’affiche en entier. Trois vues, un seul contenu à maintenir.
Au cadrage, il est utile de lister les rendus attendus pour chaque type de contenu, puisque c’est ce qui détermine le nombre de vues à développer.
Questions fréquentes
Où le contributeur choisit-il le rendu d’un composant ?
Le contributeur choisit le rendu dans Content Editor, parmi les vues que les développeurs ont prévues pour ce type de contenu. Le contenu reste le même pendant que son rendu change. Si le rendu voulu n’existe pas, la réponse est une vue à faire développer, pas un contenu à dupliquer.
Une équipe marketing peut-elle créer elle-même un nouveau composant ?
L’équipe marketing décrit le composant, les développeurs le construisent. Les développeurs déclarent le type de contenu (sa structure) et écrivent une ou plusieurs vues (son rendu), puis livrent l’ensemble dans un module déployé sur la plateforme. Les contributeurs utilisent ensuite ces composants dans les pages. L’équipe marketing intervient en amont, pour décrire les champs utiles et les rendus attendus.
Les composants servent-ils aussi dans un projet headless ?
Le contenu, oui ; le rendu, pas forcément. En headless, une application lit les contenus via l’API GraphQL, l’API recommandée pour Jahia, puis les affiche avec son propre code. Le rendu revient alors à l’application, qui lit le même contenu. Un même contenu peut toutefois servir à la fois une page rendue par Jahia et une application qui le lit via l’API.