Más información sobre cómo configurar un módulo personalizado.
En un nivel alto, configuras las opciones del módulo localmente dentro del archivo meta.json, que puede incluir las siguientes propiedades:
Parameter
Type
Description
Default
icon
String
URL de una imagen para usar como icono de un módulo.
label
String
Etiqueta utilizada cuando los módulos se muestran en los editores de contenido
module_id
Number
Id único para el módulo que es independiente de la ruta.
is_available_for_new_content
Boolean
El valor del interruptor en la esquina superior derecha del editor de módulos en HubSpot. Determina si el módulo puede ser utilizado en el contenido.
true
global
Boolean
Indica si el módulo es global o no
false
host_template_types
Matriz
Un array de tipos de contenido en los que se puede utilizar el módulo. Uno o más de [ "PAGE", "BLOG_POST", "BLOG_LISTING", "EMAIL" ].
css_assets
Matriz
Un array de archivos CSS de los que depende el módulo. Admite rutas relativas.por ejemplo, "css_assets": [{"path": "../path/to/file.css" }]
[]
css_render_options
Objetos
Establece si el módulo CSS se renderiza de forma asíncrona con async: true, false
{"async": false}
js_assets
Matriz
Un array de archivos JavaScript de los que depende el módulo. Admite rutas relativas.por ejemplo, "js_assets": [{ "path": "../path/to/file.js" }]
[]
js_render_options
Objetos
Modifica la etiqueta JavaScript del módulo agregado a la página renderizada. Las opciones incluyen:
position: head, footer
async: true, false
defer: true, false
type: string
{"position":"footer"}
inline_help_text
String
Texto de ayuda que se mostrará en la parte superior del módulo en un cuadro de información azul (límite de 300 caracteres).Proporciona la información necesaria para utilizar el módulo. Si tienes información de texto de ayuda específica del campo para transmitir, consulta la documentación del campo de texto de ayuda.
null
master_language
String
Con traducciones activadas, el código del idioma en el que se escribieron originalmente los campos del módulo.por ejemplo, en
show_module_icon: si se muestra el icono del módulo. true, false.
title: el título que aparece en el módulo en el editor. String.
description: la descripción que aparece en el módulo en el editor. String.
categories
Matriz
Una matriz que contiene hasta tres categorías de módulos.Por ejemplo: "categories":["FORMS_AND_BUTTONS"]
content_tags
Matriz
Una matriz de objetos de etiqueta de módulo que contiene el nombre de la etiqueta y la fuente de "USUARIO".Por ejemplo: "content_tags": [{"name": "BOTONES","source" : "USER"``}]
A continuación, obtén más información sobre las opciones de configuración de módulos individuales.
Los módulos pueden incluir un icono que aparece en el Administrador de diseño y en los editores de páginas y correos electrónicos para proporcionar un contexto visual a los creadores de contenido. Se recomienda tener diferentes iconos para los diferentes tipos de módulos en tu tema. Los iconos son necesarios para los proveedores del mercado.Hay dos maneras de agregar un icono, a través del administrador de diseño o de la CLI del CMS.Los iconos de los módulos deben ser un archivo .svg y tener un tamaño no superior a 10kb. Para obtener los mejores resultados, tu icono debe ser sencillo y utilizar un solo color. Los iconos que usen más de un color se convertirán automáticamente para ti. El icono del módulo predeterminado que se muestra es el de una llave inglesa y un pincel.Para agregar un icono mediante el administrador de diseño:Para agregar un icono al desarrollar localmente, abre el archivo meta.json del módulo y agrega o edita el valor del parámetro icon para que sea un SVG desde el administrador de archivos.
Para los módulos normales, el contenido de cada instancia de un módulo en una página, correo electrónico o plantilla es independiente. Para algunos casos de uso, es útil poder hacer que todas las instancias de un módulo compartan el mismo contenido. Cuando se desarrolla localmente, se puede hacer que un módulo sea global estableciendo global como true.También puedes convertir módulos en una plantilla de arrastrar y soltar a global utilizando el administrador de diseño.
Cuando se desarrolla localmente, se puede controlar en qué tipos de contenido se puede utilizar un módulo a través de la propiedad hostTemplateTypes. Más información sobre los tipos de plantillas disponibles. Los módulos también se pueden ocultar para que no se puedan agregar directamente a las páginas mediante la configuración de is_available_for_new_content a false. Por ejemplo, esto puede ser útil para los módulos creados para los menús de navegación y la búsqueda.Puedes actualizar esto en el administrador de diseño haciendo clic en la opción Tipo de plantilla en la barra lateral derecha.
Además de utilizar module.css y module.js para agregar CSS y JavaScript que se agregarán a todas las páginas que incluyan una instancia de módulo, las dependencias que se comparten entre módulos pueden adjuntarse utilizando css_assets y js_assets. Las rutas pueden ser absolutas o relativas al archivo meta.json.
Advertencia: cuando se utilizan rutas relativas para referenciar dependencias, al ejecutar hs fetch --overwrite para actualizar el módulo para el desarrollo local se sobrescribirán las rutas relativas con rutas absolutas.
Con el administrador de diseño, puedes vincular archivos CSS y JavaScript a un módulo utilizando la sección Archivos vinculados en la barra lateral derecha del editor de módulos.
Puedes asignar categorías y etiquetas a los módulos para organizarlos dentro de las herramientas de HubSpot:
Categorías: asigna categorías a módulos para organizarlos en grupos dentro de la interfaz de usuario del editor de contenido. Esto les permite a los creadores de contenido encontrar módulos más fácilmente mientras crean contenido en HubSpot. Ten en cuenta lo siguiente sobre las categorías:
Un módulo puede tener hasta tres categorías, que están predefinidas y no se pueden personalizar.
Actualmente, las categorías no aparecen en la interfaz de usuario del editor de contenido. Sin embargo, puedes asignar categorías para cuando la categorización esté disponible en los editores.
Los módulos sin categorizar estarán disponibles en una categoría Todos.
Etiquetas: asigna etiquetas para organizar módulos dentro del administrador de diseño. Esto te permite encontrar módulos más fácilmente mientras creas plantillas.
En el administrador de diseño, puedes asignar categorías y etiquetas utilizando la sección Filtrar etiquetas de la barra lateral derecha en el editor de módulos. Obtén más información sobre las categorías y etiquetas disponibles a continuación.
A nivel local, puedes agregar categorías y etiquetas al archivo meta.json de un módulo de la siguiente manera:
La matriz content_tags de un módulo puede contener cualquiera de los siguientes objetos de etiqueta de módulo (distingue entre mayúsculas y minúsculas):Tipos de contenido:
