Découvrez comment configurer un module personnalisé.
meta.json
, qui peut inclure les propriétés suivantes :
Parameter | Type | Description | Default |
---|---|---|---|
icon | Chaîne | URL d’une image à utiliser comme icône pour un module. | |
label | Chaîne | Label utilisé lorsque les modules sont affichés dans les éditeurs de contenu. | |
module_id | Nombre | Identifiant unique pour le module qui est indépendant du chemin. | |
is_available_for_new_content | Booléen | La valeur du bouton à bascule dans l’angle supérieur droit de l’éditeur de module dans HubSpot. Détermine si le module peut être utilisé dans le contenu. | true |
global | Booléen | Indique si le module est global ou non. | false |
host_template_types | Tableau | Un tableau array des types de contenu dans lesquels le module peut être utilisé. Un ou plusieurs des éléments [ "PAGE", "BLOG_POST", "BLOG_LISTING", "EMAIL" ] . | |
css_assets | Tableau | Un tableau array des fichiers CSS dont dépend le module. Les chemins relatifs sont pris en charge.Par exemple : "css_assets" : [{ "path" : "../path/to/file.css" }] . | [] |
css_render_options | Objet | Définissez si le module CSS est restitué de manière asynchrone avec async : true ou false . | {"async": false} |
js_assets | Tableau | Un tableau array des fichiers JavaScript dont dépend le module. Les chemins relatifs sont pris en charge.Par exemple : "js_assets" : [{ "path" : "../path/to/file.js" }] . | [] |
js_render_options | Objet | Modifie la balise JavaScript du module ajoutée à la page restituée. Les options comprennent :
| {"position":"footer"} |
inline_help_text | Chaîne | Texte d’aide qui sera affiché en haut du module dans une boîte d’information bleue (limite de 300 caractères).Fournit les informations nécessaires à l’utilisation du module. Si vous avez des informations de texte d’aide spécifiques au champ à transmettre, reportez-vous à la documentation sur le champ de texte d’aide. | null |
master_language | Chaîne | Lorsque les traductions sont activées, le code de la langue dans laquelle les champs du module ont été écrits à l’origine.Par exemple, en . | |
placeholder | Objet | Définit le contenu de variable pour le module. Comprend les propriétés suivantes :
| |
categories | Tableau | Un tableau contenant jusqu’à trois catégories de module.Par exemple : "categories":["FORMS_AND_BUTTONS"] | |
content_tags | Tableau | Un tableau d’objets de balise de module contenant le nom de balise et la source de "USER" .Par exemple : "content_tags": [{ "name" : "BUTTONS", "source" : "USER"``}] |
.svg
et leur taille ne doit pas dépasser 10 ko. Pour de meilleurs résultats, votre icône doit être simple et n’utiliser qu’une seule couleur. Les icônes qui utilisent plus d’une couleur seront automatiquement converties pour vous. L’icône du module qui s’affiche par défaut est une icône de clé à molette et de pinceau.
Pour ajouter une icône à l’aide du gestionnaire de conception :
Pour ajouter une icône lors du développement local, ouvrez le fichier meta.json
du module et ajoutez ou modifiez la valeur du paramètre icon
pour qu’il soit au format SVG à partir du gestionnaire de fichiers.
global
sur true
.
Vous pouvez également convertir des modules dans un modèle de glisser-déposer en global via le gestionnaire de conception.
hostTemplateTypes
. Découvrez-en davantage sur les types de modèles disponibles. Il est également possible de masquer les modules afin qu’ils ne puissent pas être ajoutés directement aux pages en définissant la valeur false
pour is_available_for_new_content
. Par exemple, cela peut être utile pour les modules conçus pour les menus de navigation et la recherche.
Vous pouvez mettre à jour cela dans le gestionnaire de conception en cliquant sur l’option Type de modèle dans la barre latérale droite.
module.css
et module.js
pour ajouter des éléments CSS et JavaScript qui seront ajoutés à toutes les pages qui incluent une instance de module, les dépendances qui sont partagées entre les modules peuvent être jointes à l’aide de css_assets
et js_assets
. Les chemins peuvent être absolus ou relatifs au fichier meta.json
.
hs fetch --overwrite
pour mettre à jour le module pour le développement local remplacera les chemins relatifs par des chemins absolus.meta.json
d’un module comme suit :
categories
d’un module peut contenir jusqu’à trois des catégories suivantes (insensibles à la casse) :
Catégorie | Description |
---|---|
blog | Modules spécifiques au blog, tels qu’un listing des publications récentes. |
body_content | Modules formatés pour présenter graphiquement le contenu, comme une galerie d’images. |
commerce | Modules spécifiques au domaine commercial, tels que les cartes de prix. |
design | Modules qui affectent la structure et la mise en page du contenu, tels que les accordéons. |
functionality | Modules qui incluent des réponses dynamiques ou un comportement sur la page, tels que des menus. |
forms_and_buttons | Modules qui permettent aux visiteurs du site de saisir et soumettre des données. |
media | Modules contenant des éléments tels que des images, des icônes, des vidéos et des bannières. |
social | Modules spécifiques aux réseaux sociaux, tels que le partage social. |
text | Modules qui ne contiennent que du texte. |
content_tags
d’un module peut contenir l’un des objets de balise de module suivants (sensible à la casse) :
Types de contenu :
ACCORDION
ANIMATION
BLOG_POST
BUTTONS
CODE
CTA
FEED
FORM
ICON
IMAGE
LISTS
LOGO
MENU
RICH_TEXT
SLIDER
TEXT
VIDEO
BANNER
BLOG
BRANDING
CALCULATOR
CONVERSION
email
GALLERY
HEADERS
INTERACTION
LAYOUT
MAP
MULTIMEDIA
NAVIGATION
PROGRESS_BAR
SEARCH
SETTINGS
social
TRANSLATION