Utilisation de modules dans les modèles

Les modules sont des zones modifiables des pages ou des e-mails HubSpot. Des instances de module peuvent être ajoutées aux modèles à l'aide de HubL. Lorsqu'il est défini dans un modèle, un module apparaît par défaut à cet emplacement dans le modèle. Si le module se trouve dans une zone modifiable, telle qu'une zone de glisser-déposer ou une colonne flexible, il peut être supprimé, déplacé et d'autres modules peuvent être ajoutés. Ce sont des instances de module.

Les définitions de module : les balises de module que vous pouvez ajouter aux modèles définissent l'état par défaut des instances de module.

Après la définition d'un module, si nécessaire, vous pouvez obtenir les valeurs de ses champs au niveau du modèle via content.widgets.

Les balises de module sont constituées des éléments suivants :

• Un nom unique pour ce module : donne au module une identité unique dans le contexte du modèle.
  
• Chemin (en fonction de la balise) : définit l'emplacement du module dans le gestionnaire de conception.
  • / désigne la racine du lecteur actuel.
  • ./ désigne le répertoire actuel.
  • ../ désigne le parent du répertoire actuel.
• Paramètres : les paramètres supplémentaires pour l'instance du module. Des valeurs par défaut au niveau du modèle sont incluses pour les champs du module.

Les balises de module HubL sont délimitées par {% et nécessitent de spécifier le type de module ainsi qu'un nom unique. Le nom unique doit être entre guillemets après le type de module. Les noms de module doivent utiliser des tirets bas au lieu d'espaces ou de tirets.

Ce nom unique est utilisé pour associer le contenu saisi avec l'éditeur de page/d'e-mail à la balise de module HubL correspondante. Par exemple, si vous codez une balise de module HubL avec le même nom dans deux zones différentes d'un modèle, les utilisateurs n'auront qu'un seul module à modifier dans l'éditeur, mais les modifications apportées à ce module s'appliqueront aux deux endroits. 

Outre les deux composants obligatoires d'une balise de module, les modules HubL prennent en charge divers paramètres qui spécifient le comportement d'un module ainsi que son rendu. Les paramètres sont des paires (clé, valeur) séparées par des virgules. Les paramètres peuvent être de différents types : chaîne de caractères, booléen, entier, énumération et liste JSON. Les paramètres de type chaîne doivent avoir leur valeur entre guillemets*, tandis que les paramètres de type booléen n'ont pas besoin de guillemets autour de leur valeur true ou false. Vous trouverez ci-dessous un exemple de module de texte de base avec un libellé et une valeur spécifiés.

Pour les modules dont les champs attendent des dictionnaires, vous pouvez les transmettre comme d'autres paramètres. Si cela vous permet une meilleure organisation ou si vous prévoyez de réutiliser les valeurs, vous pouvez définir le dictionnaire sur une variable et transmettre la variable au paramètre à la place.

Alors que la plupart des modules ont des paramètres qui contrôlent le contenu par défaut, il peut y avoir des situations où vous devez ajouter d'importants blocs de code au contenu par défaut d'un module. Par exemple, vous souhaiterez peut-être inclure un important bloc HTML comme contenu par défaut d'un module de texte enrichi ou HTML. Plutôt que d'essayer d'écrire ce code dans un paramètre de valeur, vous pouvez utiliser la syntaxe de bloc HubL.

Le paramètre qui suit immédiatement module_block ou widget_block (obsolète) est le paramètre type_of_module.

Dans presque toute notre documentation, vous noterez que nous utilisons module. Les modules HubSpot de deuxième version sont des modules normaux, comme ceux que vous pouvez créer. Il n'est donc plus nécessaire d'utiliser un autre élément type_of_module.

Alors que widget_block est obsolète, vous devriez utiliser module_block. Si vous héritez d'un site web d'un autre développeur, il peut contenir un ancien code utilisant widget_block et type_of_module.

type_of_module prend en charge les noms de modules HubSpot de première version, par exemple rich_text ou raw_html. Des paramètres supplémentaires peuvent être ajoutés à la première ligne de HubL. La deuxième ligne définit le paramètre auquel le contenu du bloc sera appliqué. Par exemple, pour un module rich_text, il s'agit du paramètre html. Pour un module raw_html, il s'agirait du paramètre value (voir les deux exemples ci-dessous). 

En plus de la syntaxe normale et de la syntaxe de bloc, il existe certains cas où vous souhaiterez spécifier un important bloc de contenu par défaut pour une variable de contenu prédéfinie. L'exemple le plus courant est la variable content.email_body. Cette variable imprime un corps d'e-mail standard qui peut être modifié dans l'éditeur de contenu. Comme il ne s'agit pas d'un module HubL standard, nous utilisons une balise content_attribute pour spécifier un bloc de contenu par défaut. L'exemple ci-dessous montre que la variable du corps de l'e-mail est renseignée avec un bloc de code de contenu par défaut.

Certains modules disposent de paramètres spéciaux, mais il existe aussi des paramètres pris en charge par tous les modules. Vous trouverez ci-dessous une liste des paramètres pris en charge par tous les modules.

Dans ce cas, faq_group_title ne fait pas partie des paramètres disponibles pour tous les modules. faq_group_title est spécifique à ce module personnalisé. Il s'agit du nom de variable pour un champ du module.

Certains champs sont simples et le paramètre attend simplement une chaîne de caractères, un nombre entier, un élément true/false. D'autres peuvent s'attendre à un objet. C'est à vous de fournir les valeurs dans le format correct, car il n'y a pas de validation des valeurs dans l'éditeur en fonction des paramètres que vous avez définis dans les paramètres de champ du module personnalisé. Exemple : Un module possède un champ numérique dont la valeur minimale est fixée à 1. Vous transmettez au paramètre la valeur 0. Il n'y a pas d'avertissement pour indiquer que votre valeur est non valide.